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. */
171 /** Payload is struct sr_datafeed_analog2. */
175 /** Measured quantity, sr_datafeed_analog.mq. */
177 SR_MQ_VOLTAGE = 10000,
183 /** Duty cycle, e.g. on/off ratio. */
185 /** Continuity test. */
189 /** Electrical power, usually in W, or dBm. */
191 /** Gain (a transistor's gain, or hFE, for example). */
193 /** Logarithmic representation of sound pressure relative to a
194 * reference value. */
195 SR_MQ_SOUND_PRESSURE_LEVEL,
196 /** Carbon monoxide level */
197 SR_MQ_CARBON_MONOXIDE,
199 SR_MQ_RELATIVE_HUMIDITY,
206 /** Parallel inductance (LCR meter model). */
207 SR_MQ_PARALLEL_INDUCTANCE,
208 /** Parallel capacitance (LCR meter model). */
209 SR_MQ_PARALLEL_CAPACITANCE,
210 /** Parallel resistance (LCR meter model). */
211 SR_MQ_PARALLEL_RESISTANCE,
212 /** Series inductance (LCR meter model). */
213 SR_MQ_SERIES_INDUCTANCE,
214 /** Series capacitance (LCR meter model). */
215 SR_MQ_SERIES_CAPACITANCE,
216 /** Series resistance (LCR meter model). */
217 SR_MQ_SERIES_RESISTANCE,
218 /** Dissipation factor. */
219 SR_MQ_DISSIPATION_FACTOR,
220 /** Quality factor. */
221 SR_MQ_QUALITY_FACTOR,
224 /** Difference from reference value. */
228 /** Unit of measured quantity, sr_datafeed_analog.unit. */
231 SR_UNIT_VOLT = 10000,
232 /** Ampere (current). */
234 /** Ohm (resistance). */
236 /** Farad (capacity). */
238 /** Kelvin (temperature). */
240 /** Degrees Celsius (temperature). */
242 /** Degrees Fahrenheit (temperature). */
244 /** Hertz (frequency, 1/s, [Hz]). */
246 /** Percent value. */
248 /** Boolean value. */
250 /** Time in seconds. */
252 /** Unit of conductance, the inverse of resistance. */
255 * An absolute measurement of power, in decibels, referenced to
259 /** Voltage in decibel, referenced to 1 volt (dBV). */
260 SR_UNIT_DECIBEL_VOLT,
262 * Measurements that intrinsically do not have units attached, such
263 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
264 * a unitless quantity, for example.
267 /** Sound pressure level, in decibels, relative to 20 micropascals. */
270 * Normalized (0 to 1) concentration of a substance or compound with 0
271 * representing a concentration of 0%, and 1 being 100%. This is
272 * represented as the fraction of number of particles of the substance.
274 SR_UNIT_CONCENTRATION,
275 /** Revolutions per minute. */
276 SR_UNIT_REVOLUTIONS_PER_MINUTE,
277 /** Apparent power [VA]. */
279 /** Real power [W]. */
281 /** Consumption [Wh]. */
283 /** Wind speed in meters per second. */
284 SR_UNIT_METER_SECOND,
285 /** Pressure in hectopascal */
287 /** Relative humidity assuming air temperature of 293 kelvin (%rF). */
288 SR_UNIT_HUMIDITY_293K,
289 /** Plane angle in 1/360th of a full circle. */
291 /** Henry (inductance). */
295 /** Values for sr_datafeed_analog.flags. */
297 /** Voltage measurement is alternating current (AC). */
299 /** Voltage measurement is direct current (DC). */
301 /** This is a true RMS measurement. */
302 SR_MQFLAG_RMS = 0x04,
303 /** Value is voltage drop across a diode, or NAN. */
304 SR_MQFLAG_DIODE = 0x08,
305 /** Device is in "hold" mode (repeating the last measurement). */
306 SR_MQFLAG_HOLD = 0x10,
307 /** Device is in "max" mode, only updating upon a new max value. */
308 SR_MQFLAG_MAX = 0x20,
309 /** Device is in "min" mode, only updating upon a new min value. */
310 SR_MQFLAG_MIN = 0x40,
311 /** Device is in autoranging mode. */
312 SR_MQFLAG_AUTORANGE = 0x80,
313 /** Device is in relative mode. */
314 SR_MQFLAG_RELATIVE = 0x100,
315 /** Sound pressure level is A-weighted in the frequency domain,
316 * according to IEC 61672:2003. */
317 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
318 /** Sound pressure level is C-weighted in the frequency domain,
319 * according to IEC 61672:2003. */
320 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
321 /** Sound pressure level is Z-weighted (i.e. not at all) in the
322 * frequency domain, according to IEC 61672:2003. */
323 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
324 /** Sound pressure level is not weighted in the frequency domain,
325 * albeit without standards-defined low and high frequency limits. */
326 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
327 /** Sound pressure level measurement is S-weighted (1s) in the
329 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
330 /** Sound pressure level measurement is F-weighted (125ms) in the
332 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
333 /** Sound pressure level is time-averaged (LAT), also known as
334 * Equivalent Continuous A-weighted Sound Level (LEQ). */
335 SR_MQFLAG_SPL_LAT = 0x8000,
336 /** Sound pressure level represented as a percentage of measurements
337 * that were over a preset alarm level. */
338 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
339 /** Time is duration (as opposed to epoch, ...). */
340 SR_MQFLAG_DURATION = 0x20000,
341 /** Device is in "avg" mode, averaging upon each new value. */
342 SR_MQFLAG_AVG = 0x40000,
343 /** Reference value shown. */
344 SR_MQFLAG_REFERENCE = 0x80000,
347 enum sr_trigger_matches {
357 /** The representation of a trigger, consisting of one or more stages
358 * containing one or more matches on a channel.
361 /** A name for this trigger. This may be NULL if none is needed. */
363 /** List of pointers to struct sr_trigger_stage. */
367 /** A trigger stage. */
368 struct sr_trigger_stage {
371 /** List of pointers to struct sr_trigger_match. */
375 /** A channel to match and what to match it on. */
376 struct sr_trigger_match {
377 /** The channel to trigger on. */
378 struct sr_channel *channel;
379 /** The trigger match to use.
380 * For logic channels, only the following matches may be used:
387 * For analog channels, only these matches may be used:
395 /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
396 * this contains the value to compare against. */
402 * Opaque structure representing a libsigrok context.
404 * None of the fields of this structure are meant to be accessed directly.
406 * @see sr_init(), sr_exit().
412 * Opaque structure representing a libsigrok session.
414 * None of the fields of this structure are meant to be accessed directly.
416 * @see sr_session_new(), sr_session_destroy().
421 /** Numerator of the rational number. */
423 /** Denominator of the rational number. */
427 /** Packet in a sigrok data feed. */
428 struct sr_datafeed_packet {
433 /** Header of a sigrok data feed. */
434 struct sr_datafeed_header {
436 struct timeval starttime;
439 /** Datafeed payload for type SR_DF_META. */
440 struct sr_datafeed_meta {
444 /** Logic datafeed payload for type SR_DF_LOGIC. */
445 struct sr_datafeed_logic {
451 /** Analog datafeed payload for type SR_DF_ANALOG. */
452 struct sr_datafeed_analog {
453 /** The channels for which data is included in this packet. */
455 /** Number of samples in data */
457 /** Measured quantity (voltage, current, temperature, and so on).
458 * Use SR_MQ_VOLTAGE, ... */
460 /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
462 /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
464 /** The analog value(s). The data is interleaved according to
465 * the channels list. */
469 /** Analog datafeed payload for type SR_DF_ANALOG2. */
470 struct sr_datafeed_analog2 {
472 uint32_t num_samples;
473 struct sr_analog_encoding *encoding;
474 struct sr_analog_meaning *meaning;
475 struct sr_analog_spec *spec;
478 struct sr_analog_encoding {
482 gboolean is_bigendian;
484 gboolean is_digits_decimal;
485 struct sr_rational scale;
486 struct sr_rational offset;
489 struct sr_analog_meaning {
492 enum sr_mqflag mqflags;
496 struct sr_analog_spec {
500 /** Generic option struct used by various subsystems. */
502 /* Short name suitable for commandline usage, [a-z0-9-]. */
504 /* Short name suitable for GUI usage, can contain UTF-8. */
506 /* Description of the option, in a sentence. */
508 /* Default value for this option. */
510 /* List of possible values, if this is an option with few values. */
515 struct sr_input_module;
517 struct sr_output_module;
519 struct sr_transform_module;
521 /** Constants for channel type. */
522 enum sr_channeltype {
523 /** Channel type is logic channel. */
524 SR_CHANNEL_LOGIC = 10000,
525 /** Channel type is analog channel. */
529 /** Information on single channel. */
531 /** The index of this channel, starting at 0. Logic channels will
532 * be encoded according to this index in SR_DF_LOGIC packets. */
534 /** Channel type (SR_CHANNEL_LOGIC, ...) */
536 /** Is this channel enabled? */
538 /** Name of channel. */
540 /** Private data for driver use. */
544 /** Structure for groups of channels that have common properties. */
545 struct sr_channel_group {
546 /** Name of the channel group. */
548 /** List of sr_channel structs of the channels belonging to this group. */
550 /** Private data for driver use. */
554 /** Used for setting or getting value of a config item. */
556 /** Config key like SR_CONF_CONN, etc. */
558 /** Key-specific data. */
562 /** Information about a config key. */
563 struct sr_config_info {
564 /** Config key like SR_CONF_CONN, etc. */
566 /** Data type like SR_T_STRING, etc. */
568 /** Id string, e.g. "serialcomm". */
570 /** Name, e.g. "Serial communication". */
572 /** Verbose description (unused currently). */
576 #define SR_CONF_GET (1 << 31)
577 #define SR_CONF_SET (1 << 30)
578 #define SR_CONF_LIST (1 << 29)
579 #define SR_CONF_MASK 0x1fffffff
581 /** Configuration keys */
583 /*--- Device classes ------------------------------------------------*/
585 /** The device can act as logic analyzer. */
586 SR_CONF_LOGIC_ANALYZER = 10000,
588 /** The device can act as an oscilloscope. */
589 SR_CONF_OSCILLOSCOPE,
591 /** The device can act as a multimeter. */
594 /** The device is a demo device. */
597 /** The device can act as a sound level meter. */
598 SR_CONF_SOUNDLEVELMETER,
600 /** The device can measure temperature. */
603 /** The device can measure humidity. */
606 /** The device can measure energy consumption. */
609 /** The device can act as a signal demodulator. */
612 /** The device can act as a programmable power supply. */
613 SR_CONF_POWER_SUPPLY,
615 /** The device can act as an LCR meter. */
618 /*--- Driver scan options -------------------------------------------*/
621 * Specification on how to connect to a device.
623 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
624 * the form which makes sense to the OS (e.g., /dev/ttyS0).
625 * Otherwise this specifies a USB device, either in the form of
626 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
627 * @verbatim <vendorid>.<productid> @endverbatim
628 * (hexadecimal, e.g. 1d6b.0001).
630 SR_CONF_CONN = 20000,
633 * Serial communication specification, in the form:
635 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
639 * The string may also be followed by one or more special settings,
640 * in the form "/key=value". Supported keys and their values are:
642 * rts 0,1 set the port's RTS pin to low or high
643 * dtr 0,1 set the port's DTR pin to low or high
644 * flow 0 no flow control
645 * 1 hardware-based (RTS/CTS) flow control
646 * 2 software-based (XON/XOFF) flow control
648 * This is always an optional parameter, since a driver typically
649 * knows the speed at which the device wants to communicate.
653 /*--- Device (or channel group) configuration -----------------------*/
655 /** The device supports setting its samplerate, in Hz. */
656 SR_CONF_SAMPLERATE = 30000,
658 /** The device supports setting a pre/post-trigger capture ratio. */
659 SR_CONF_CAPTURE_RATIO,
661 /** The device supports setting a pattern (pattern generator mode). */
662 SR_CONF_PATTERN_MODE,
664 /** The device supports run-length encoding (RLE). */
667 /** The device supports setting trigger slope. */
668 SR_CONF_TRIGGER_SLOPE,
670 /** The device supports averaging. */
674 * The device supports setting number of samples to be
679 /** Trigger source. */
680 SR_CONF_TRIGGER_SOURCE,
682 /** Horizontal trigger position. */
683 SR_CONF_HORIZ_TRIGGERPOS,
700 /** Trigger matches. */
701 SR_CONF_TRIGGER_MATCH,
703 /** The device supports setting its sample interval, in ms. */
704 SR_CONF_SAMPLE_INTERVAL,
706 /** Number of timebases, as related to SR_CONF_TIMEBASE. */
707 SR_CONF_NUM_TIMEBASE,
709 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
712 /** Sound pressure level frequency weighting. */
713 SR_CONF_SPL_WEIGHT_FREQ,
715 /** Sound pressure level time weighting. */
716 SR_CONF_SPL_WEIGHT_TIME,
718 /** Sound pressure level measurement range. */
719 SR_CONF_SPL_MEASUREMENT_RANGE,
721 /** Max hold mode. */
724 /** Min hold mode. */
727 /** Logic low-high threshold range. */
728 SR_CONF_VOLTAGE_THRESHOLD,
730 /** The device supports using an external clock. */
731 SR_CONF_EXTERNAL_CLOCK,
734 * The device supports swapping channels. Typical this is between
735 * buffered and unbuffered channels.
739 /** Center frequency.
740 * The input signal is downmixed by this frequency before the ADC
741 * anti-aliasing filter.
743 SR_CONF_CENTER_FREQUENCY,
745 /** The device supports setting the number of logic channels. */
746 SR_CONF_NUM_LOGIC_CHANNELS,
748 /** The device supports setting the number of analog channels. */
749 SR_CONF_NUM_ANALOG_CHANNELS,
754 * @arg get: get measured output voltage
756 SR_CONF_OUTPUT_VOLTAGE,
759 * Maximum output voltage target.
761 * @arg get: get output voltage target
762 * @arg set: change output voltage target
764 SR_CONF_OUTPUT_VOLTAGE_TARGET,
769 * @arg get: get measured output current
771 SR_CONF_OUTPUT_CURRENT,
774 * Output current limit.
776 * @arg get: get output current limit
777 * @arg set: change output current limit
779 SR_CONF_OUTPUT_CURRENT_LIMIT,
782 * Enabling/disabling output.
784 * @arg get: @b true if currently enabled
785 * @arg set: enable/disable
787 SR_CONF_OUTPUT_ENABLED,
790 * Output channel configuration.
792 * @arg get: get current setting
793 * @arg set: change current setting
794 * @arg list: array of possible values
796 SR_CONF_OUTPUT_CHANNEL_CONFIG,
799 * Over-voltage protection (OVP) feature
801 * @arg get: @b true if currently enabled
802 * @arg set: enable/disable
804 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED,
807 * Over-voltage protection (OVP) active
809 * @arg get: @b true if device has activated OVP, i.e. the output voltage
810 * exceeds the over-voltage protection threshold.
812 SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
815 * Over-voltage protection (OVP) threshold
816 * @arg type: double (voltage)
817 * @arg get: get current threshold
818 * @arg set: set new threshold
820 SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD,
823 * Over-current protection (OCP) feature
825 * @arg get: @b true if currently enabled
826 * @arg set: enable/disable
828 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED,
831 * Over-current protection (OCP) active
833 * @arg get: @b true if device has activated OCP, i.e. the output current
834 * exceeds the over-current protection threshold.
836 SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
839 * Over-current protection (OCP) threshold
840 * @arg type: double (current)
841 * @arg get: get current threshold
842 * @arg set: set new threshold
844 SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD,
846 /** Choice of clock edge for external clock ("r" or "f"). */
849 /** Amplitude of a source without strictly-defined MQ. */
853 * Output channel regulation
854 * get: "CV", "CC" or "UR", denoting constant voltage, constant current
857 SR_CONF_OUTPUT_REGULATION,
859 /** Over-temperature protection (OTP) */
860 SR_CONF_OVER_TEMPERATURE_PROTECTION,
862 /** Output frequency in Hz. */
863 SR_CONF_OUTPUT_FREQUENCY,
865 /** Measured quantity. */
866 SR_CONF_MEASURED_QUANTITY,
868 /** Measured secondary quantity. */
869 SR_CONF_MEASURED_2ND_QUANTITY,
871 /** Equivalent circuit model. */
872 SR_CONF_EQUIV_CIRCUIT_MODEL,
874 /*--- Special stuff -------------------------------------------------*/
876 /** Scan options supported by the driver. */
877 SR_CONF_SCAN_OPTIONS = 40000,
879 /** Device options for a particular device. */
880 SR_CONF_DEVICE_OPTIONS,
882 /** Session filename. */
885 /** The device supports specifying a capturefile to inject. */
888 /** The device supports specifying the capturefile unit size. */
889 SR_CONF_CAPTURE_UNITSIZE,
891 /** Power off the device. */
895 * Data source for acquisition. If not present, acquisition from
896 * the device is always "live", i.e. acquisition starts when the
897 * frontend asks and the results are sent out as soon as possible.
899 * If present, it indicates that either the device has no live
900 * acquisition capability (for example a pure data logger), or
901 * there is a choice. sr_config_list() returns those choices.
903 * In any case if a device has live acquisition capabilities, it
904 * is always the default.
908 /*--- Acquisition modes, sample limiting ----------------------------*/
911 * The device supports setting a sample time limit (how long
912 * the sample acquisition should run, in ms).
914 SR_CONF_LIMIT_MSEC = 50000,
917 * The device supports setting a sample number limit (how many
918 * samples should be acquired).
920 SR_CONF_LIMIT_SAMPLES,
923 * The device supports setting a frame limit (how many
924 * frames should be acquired).
926 SR_CONF_LIMIT_FRAMES,
929 * The device supports continuous sampling. Neither a time limit
930 * nor a sample number limit has to be supplied, it will just acquire
931 * samples continuously, until explicitly stopped by a certain command.
935 /** The device has internal storage, into which data is logged. This
936 * starts or stops the internal logging. */
939 /** Device mode for multi-function devices. */
942 /** Self test mode. */
947 * Opaque structure representing a libsigrok device instance.
949 * None of the fields of this structure are meant to be accessed directly.
953 /** Types of device instance, struct sr_dev_inst.type */
954 enum sr_dev_inst_type {
955 /** Device instance type for USB devices. */
957 /** Device instance type for serial port devices. */
959 /** Device instance type for SCPI devices. */
961 /** Device-instance type for user-created "devices". */
965 /** Device instance status, struct sr_dev_inst.status */
966 enum sr_dev_inst_status {
967 /** The device instance was not found. */
968 SR_ST_NOT_FOUND = 10000,
969 /** The device instance was found, but is still booting. */
971 /** The device instance is live, but not in use. */
973 /** The device instance is actively in use in a session. */
975 /** The device is winding down its session. */
979 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
980 struct sr_dev_driver {
981 /* Driver-specific */
982 /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
984 /** Long name. Verbose driver name shown to user. */
986 /** API version (currently 1). */
988 /** Called when driver is loaded, e.g. program startup. */
989 int (*init) (struct sr_context *sr_ctx);
990 /** Called before driver is unloaded.
991 * Driver must free all resources held by it. */
992 int (*cleanup) (void);
993 /** Scan for devices. Driver should do all initialisation required.
994 * Can be called several times, e.g. with different port options.
995 * \retval NULL Error or no devices found.
996 * \retval other GSList of a struct sr_dev_inst for each device.
997 * Must be freed by caller!
999 GSList *(*scan) (GSList *options);
1000 /** Get list of device instances the driver knows about.
1001 * \returns NULL or GSList of a struct sr_dev_inst for each device.
1002 * Must not be freed by caller!
1004 GSList *(*dev_list) (void);
1005 /** Clear list of devices the driver knows about. */
1006 int (*dev_clear) (void);
1007 /** Query value of a configuration key in driver or given device instance.
1008 * @see sr_config_get().
1010 int (*config_get) (uint32_t key, GVariant **data,
1011 const struct sr_dev_inst *sdi,
1012 const struct sr_channel_group *cg);
1013 /** Set value of a configuration key in driver or a given device instance.
1014 * @see sr_config_set(). */
1015 int (*config_set) (uint32_t key, GVariant *data,
1016 const struct sr_dev_inst *sdi,
1017 const struct sr_channel_group *cg);
1018 /** Channel status change.
1019 * @see sr_dev_channel_enable(). */
1020 int (*config_channel_set) (const struct sr_dev_inst *sdi,
1021 struct sr_channel *ch, unsigned int changes);
1022 /** Apply configuration settings to the device hardware.
1023 * @see sr_config_commit().*/
1024 int (*config_commit) (const struct sr_dev_inst *sdi);
1025 /** List all possible values for a configuration key in a device instance.
1026 * @see sr_config_list().
1028 int (*config_list) (uint32_t key, GVariant **data,
1029 const struct sr_dev_inst *sdi,
1030 const struct sr_channel_group *cg);
1032 /* Device-specific */
1034 int (*dev_open) (struct sr_dev_inst *sdi);
1036 int (*dev_close) (struct sr_dev_inst *sdi);
1037 /** Begin data acquisition on the specified device. */
1038 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
1040 /** End data acquisition on the specified device. */
1041 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
1045 /** Device driver private data. Initialized by init(). */
1050 * @struct sr_session
1052 * Opaque data structure representing a libsigrok session. None of the fields
1053 * of this structure are meant to be accessed directly.
1057 /** Serial port descriptor. */
1058 struct sr_serial_port {
1059 /** The OS dependent name of the serial port. */
1061 /** An end user friendly description for the serial port. */
1066 #include "version.h"