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,
204 /** Unit of measured quantity, sr_datafeed_analog.unit. */
207 SR_UNIT_VOLT = 10000,
208 /** Ampere (current). */
210 /** Ohm (resistance). */
212 /** Farad (capacity). */
214 /** Kelvin (temperature). */
216 /** Degrees Celsius (temperature). */
218 /** Degrees Fahrenheit (temperature). */
220 /** Hertz (frequency, 1/s, [Hz]). */
222 /** Percent value. */
224 /** Boolean value. */
226 /** Time in seconds. */
228 /** Unit of conductance, the inverse of resistance. */
231 * An absolute measurement of power, in decibels, referenced to
235 /** Voltage in decibel, referenced to 1 volt (dBV). */
236 SR_UNIT_DECIBEL_VOLT,
238 * Measurements that intrinsically do not have units attached, such
239 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
240 * a unitless quantity, for example.
243 /** Sound pressure level, in decibels, relative to 20 micropascals. */
246 * Normalized (0 to 1) concentration of a substance or compound with 0
247 * representing a concentration of 0%, and 1 being 100%. This is
248 * represented as the fraction of number of particles of the substance.
250 SR_UNIT_CONCENTRATION,
251 /** Revolutions per minute. */
252 SR_UNIT_REVOLUTIONS_PER_MINUTE,
253 /** Apparent power [VA]. */
255 /** Real power [W]. */
257 /** Consumption [Wh]. */
259 /** Wind speed in meters per second. */
260 SR_UNIT_METER_SECOND,
261 /** Pressure in hectopascal */
263 /** Relative humidity assuming air temperature of 293 kelvin (%rF). */
264 SR_UNIT_HUMIDITY_293K,
267 /** Values for sr_datafeed_analog.flags. */
269 /** Voltage measurement is alternating current (AC). */
271 /** Voltage measurement is direct current (DC). */
273 /** This is a true RMS measurement. */
274 SR_MQFLAG_RMS = 0x04,
275 /** Value is voltage drop across a diode, or NAN. */
276 SR_MQFLAG_DIODE = 0x08,
277 /** Device is in "hold" mode (repeating the last measurement). */
278 SR_MQFLAG_HOLD = 0x10,
279 /** Device is in "max" mode, only updating upon a new max value. */
280 SR_MQFLAG_MAX = 0x20,
281 /** Device is in "min" mode, only updating upon a new min value. */
282 SR_MQFLAG_MIN = 0x40,
283 /** Device is in autoranging mode. */
284 SR_MQFLAG_AUTORANGE = 0x80,
285 /** Device is in relative mode. */
286 SR_MQFLAG_RELATIVE = 0x100,
287 /** Sound pressure level is A-weighted in the frequency domain,
288 * according to IEC 61672:2003. */
289 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
290 /** Sound pressure level is C-weighted in the frequency domain,
291 * according to IEC 61672:2003. */
292 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
293 /** Sound pressure level is Z-weighted (i.e. not at all) in the
294 * frequency domain, according to IEC 61672:2003. */
295 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
296 /** Sound pressure level is not weighted in the frequency domain,
297 * albeit without standards-defined low and high frequency limits. */
298 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
299 /** Sound pressure level measurement is S-weighted (1s) in the
301 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
302 /** Sound pressure level measurement is F-weighted (125ms) in the
304 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
305 /** Sound pressure level is time-averaged (LAT), also known as
306 * Equivalent Continuous A-weighted Sound Level (LEQ). */
307 SR_MQFLAG_SPL_LAT = 0x8000,
308 /** Sound pressure level represented as a percentage of measurements
309 * that were over a preset alarm level. */
310 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
311 /** Time is duration (as opposed to epoch, ...). */
312 SR_MQFLAG_DURATION = 0x20000,
313 /** Device is in "avg" mode, averaging upon each new value. */
314 SR_MQFLAG_AVG = 0x40000,
317 enum sr_trigger_matches {
327 /** The representation of a trigger, consisting of one or more stages
328 * containing one or more matches on a channel.
331 /** A name for this trigger. This may be NULL if none is needed. */
333 /** List of pointers to struct sr_trigger_stage. */
337 /** A trigger stage. */
338 struct sr_trigger_stage {
341 /** List of pointers to struct sr_trigger_match. */
345 /** A channel to match and what to match it on. */
346 struct sr_trigger_match {
347 /** The channel to trigger on. */
348 struct sr_channel *channel;
349 /** The trigger match to use.
350 * For logic channels, only the following matches may be used:
357 * For analog channels, only these matches may be used:
365 /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
366 * this contains the value to compare against. */
372 * Opaque structure representing a libsigrok context.
374 * None of the fields of this structure are meant to be accessed directly.
376 * @see sr_init(), sr_exit().
380 /** Packet in a sigrok data feed. */
381 struct sr_datafeed_packet {
386 /** Header of a sigrok data feed. */
387 struct sr_datafeed_header {
389 struct timeval starttime;
392 /** Datafeed payload for type SR_DF_META. */
393 struct sr_datafeed_meta {
397 /** Logic datafeed payload for type SR_DF_LOGIC. */
398 struct sr_datafeed_logic {
404 /** Analog datafeed payload for type SR_DF_ANALOG. */
405 struct sr_datafeed_analog {
406 /** The channels for which data is included in this packet. */
408 /** Number of samples in data */
410 /** Measured quantity (voltage, current, temperature, and so on).
411 * Use SR_MQ_VOLTAGE, ... */
413 /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
415 /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
417 /** The analog value(s). The data is interleaved according to
418 * the channels list. */
422 /** Input (file) format struct. */
425 * A pointer to this input format's 'struct sr_input_format'.
426 * The frontend can use this to call the module's callbacks.
428 struct sr_input_format *format;
432 struct sr_dev_inst *sdi;
437 /** Input (file) format driver. */
438 struct sr_input_format {
439 /** The unique ID for this input format. Must not be NULL. */
443 * A short description of the input format, which can (for example)
444 * be displayed to the user by frontends. Must not be NULL.
449 * Check if this input module can load and parse the specified file.
451 * @param[in] filename The name (and path) of the file to check.
453 * @retval TRUE This module knows the format.
454 * @retval FALSE This module does not know the format.
456 int (*format_match) (const char *filename);
459 * Initialize the input module.
461 * @param in A pointer to a valid 'struct sr_input' that the caller
462 * has to allocate and provide to this function. It is also
463 * the responsibility of the caller to free it later.
464 * @param[in] filename The name (and path) of the file to use.
466 * @retval SR_OK Success
467 * @retval other Negative error code.
469 int (*init) (struct sr_input *in, const char *filename);
472 * Load a file, parsing the input according to the file's format.
474 * This function will send datafeed packets to the session bus, so
475 * the calling frontend must have registered its session callbacks
478 * The packet types sent across the session bus by this function must
479 * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
480 * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
483 * @param in A pointer to a valid 'struct sr_input' that the caller
484 * has to allocate and provide to this function. It is also
485 * the responsibility of the caller to free it later.
486 * @param filename The name (and path) of the file to use.
488 * @retval SR_OK Success
489 * @retval other Negative error code.
491 int (*loadfile) (struct sr_input *in, const char *filename);
494 /** Output (file) format struct. */
496 /** A pointer to this output's format. */
497 struct sr_output_format *format;
500 * The device for which this output module is creating output. This
501 * can be used by the module to find out channel names and numbers.
503 const struct sr_dev_inst *sdi;
506 * An optional parameter which the frontend can pass in to the
507 * output module. How the string is interpreted is entirely up to
513 * A generic pointer which can be used by the module to keep internal
514 * state between calls into its callback functions.
516 * For example, the module might store a pointer to a chunk of output
517 * there, and only flush it when it reaches a certain size.
522 /** Output (file) format driver. */
523 struct sr_output_format {
525 * A unique ID for this output format. Must not be NULL.
527 * It can be used by frontends to select this output format for use.
529 * For example, calling sigrok-cli with <code>-O hex</code> will
530 * select the hexadecimal text output format.
535 * A short description of the output format. Must not be NULL.
537 * This can be displayed by frontends, e.g. when selecting the output
538 * format for saving a file.
543 * This function is called once, at the beginning of an output stream.
545 * The device struct will be available in the output struct passed in,
546 * as well as the param field -- which may be NULL or an empty string,
547 * if no parameter was passed.
549 * The module can use this to initialize itself, create a struct for
550 * keeping state and storing it in the <code>internal</code> field.
552 * @param o Pointer to the respective 'struct sr_output'.
554 * @retval SR_OK Success
555 * @retval other Negative error code.
557 int (*init) (struct sr_output *o);
560 * This function is passed a copy of every packed in the data feed.
561 * Any output generated by the output module in response to the
562 * packet should be returned in a newly allocated GString
563 * <code>out</code>, which will be freed by the caller.
565 * Packets not of interest to the output module can just be ignored,
566 * and the <code>out</code> parameter set to NULL.
568 * @param o Pointer to the respective 'struct sr_output'.
569 * @param sdi The device instance that generated the packet.
570 * @param packet The complete packet.
571 * @param out A pointer where a GString * should be stored if
572 * the module generates output, or NULL if not.
574 * @retval SR_OK Success
575 * @retval other Negative error code.
577 int (*receive) (struct sr_output *o,
578 const struct sr_datafeed_packet *packet, GString **out);
581 * This function is called after the caller is finished using
582 * the output module, and can be used to free any internal
583 * resources the module may keep.
585 * @retval SR_OK Success
586 * @retval other Negative error code.
588 int (*cleanup) (struct sr_output *o);
591 /** Constants for channel type. */
592 enum sr_channeltype {
593 /** Channel type is logic channel. */
594 SR_CHANNEL_LOGIC = 10000,
595 /** Channel type is analog channel. */
599 /** Information on single channel. */
601 /** The index of this channel, starting at 0. Logic channels will
602 * be encoded according to this index in SR_DF_LOGIC packets. */
604 /** Channel type (SR_CHANNEL_LOGIC, ...) */
606 /** Is this channel enabled? */
608 /** Name of channel. */
612 /** Structure for groups of channels that have common properties. */
613 struct sr_channel_group {
614 /** Name of the channel group. */
616 /** List of sr_channel structs of the channels belonging to this group. */
618 /** Private data for driver use. */
622 /** Used for setting or getting value of a config item. */
624 /** Config key like SR_CONF_CONN, etc. */
626 /** Key-specific data. */
630 /** Information about a config key. */
631 struct sr_config_info {
632 /** Config key like SR_CONF_CONN, etc. */
634 /** Data type like SR_T_STRING, etc. */
636 /** Id string, e.g. "serialcomm". */
638 /** Name, e.g. "Serial communication". */
640 /** Verbose description (unused currently). */
644 /** Constants for device classes */
646 /*--- Device classes ------------------------------------------------*/
648 /** The device can act as logic analyzer. */
649 SR_CONF_LOGIC_ANALYZER = 10000,
651 /** The device can act as an oscilloscope. */
652 SR_CONF_OSCILLOSCOPE,
654 /** The device can act as a multimeter. */
657 /** The device is a demo device. */
660 /** The device can act as a sound level meter. */
661 SR_CONF_SOUNDLEVELMETER,
663 /** The device can measure temperature. */
666 /** The device can measure humidity. */
669 /** The device can measure energy consumption. */
672 /** The device can demodulate signals. */
675 /** Programmable power supply. */
676 SR_CONF_POWER_SUPPLY,
678 /*--- Driver scan options -------------------------------------------*/
681 * Specification on how to connect to a device.
683 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
684 * the form which makes sense to the OS (e.g., /dev/ttyS0).
685 * Otherwise this specifies a USB device, either in the form of
686 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
687 * @verbatim <vendorid>.<productid> @endverbatim
688 * (hexadecimal, e.g. 1d6b.0001).
690 SR_CONF_CONN = 20000,
693 * Serial communication specification, in the form:
695 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
699 * The string may also be followed by one or more special settings,
700 * in the form "/key=value". Supported keys and their values are:
702 * rts 0,1 set the port's RTS pin to low or high
703 * dtr 0,1 set the port's DTR pin to low or high
704 * flow 0 no flow control
705 * 1 hardware-based (RTS/CTS) flow control
706 * 2 software-based (XON/XOFF) flow control
708 * This is always an optional parameter, since a driver typically
709 * knows the speed at which the device wants to communicate.
713 /*--- Device configuration ------------------------------------------*/
715 /** The device supports setting its samplerate, in Hz. */
716 SR_CONF_SAMPLERATE = 30000,
718 /** The device supports setting a pre/post-trigger capture ratio. */
719 SR_CONF_CAPTURE_RATIO,
721 /** The device supports setting a pattern (pattern generator mode). */
722 SR_CONF_PATTERN_MODE,
724 /** The device supports Run Length Encoding. */
727 /** The device supports setting trigger slope. */
728 SR_CONF_TRIGGER_SLOPE,
730 /** Trigger source. */
731 SR_CONF_TRIGGER_SOURCE,
733 /** Horizontal trigger position. */
734 SR_CONF_HORIZ_TRIGGERPOS,
751 /** Trigger matches. */
752 SR_CONF_TRIGGER_MATCH,
754 /** The device supports setting its sample interval, in ms. */
755 SR_CONF_SAMPLE_INTERVAL,
757 /** Number of timebases, as related to SR_CONF_TIMEBASE. */
758 SR_CONF_NUM_TIMEBASE,
760 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
763 /** Sound pressure level frequency weighting. */
764 SR_CONF_SPL_WEIGHT_FREQ,
766 /** Sound pressure level time weighting. */
767 SR_CONF_SPL_WEIGHT_TIME,
769 /** Sound pressure level measurement range. */
770 SR_CONF_SPL_MEASUREMENT_RANGE,
772 /** Max hold mode. */
775 /** Min hold mode. */
778 /** Logic low-high threshold range. */
779 SR_CONF_VOLTAGE_THRESHOLD,
781 /** The device supports using an external clock. */
782 SR_CONF_EXTERNAL_CLOCK,
785 * The device supports swapping channels. Typical this is between
786 * buffered and unbuffered channels.
790 /** Center frequency.
791 * The input signal is downmixed by this frequency before the ADC
792 * anti-aliasing filter.
794 SR_CONF_CENTER_FREQUENCY,
796 /** The device supports setting the number of logic channels. */
797 SR_CONF_NUM_LOGIC_CHANNELS,
799 /** The device supports setting the number of analog channels. */
800 SR_CONF_NUM_ANALOG_CHANNELS,
802 /** Output voltage. */
803 SR_CONF_OUTPUT_VOLTAGE,
805 /** Maximum output voltage. */
806 SR_CONF_OUTPUT_VOLTAGE_MAX,
808 /** Output current. */
809 SR_CONF_OUTPUT_CURRENT,
811 /** Maximum output current. */
812 SR_CONF_OUTPUT_CURRENT_MAX,
814 /** Enabling/disabling output. */
815 SR_CONF_OUTPUT_ENABLED,
817 /** Channel output configuration. */
818 SR_CONF_OUTPUT_CHANNEL,
820 /** Over-voltage protection (OVP) */
821 SR_CONF_OVER_VOLTAGE_PROTECTION,
823 /** Over-current protection (OCP) */
824 SR_CONF_OVER_CURRENT_PROTECTION,
826 /** Choice of clock edge for external clock ("r" or "f"). */
829 /*--- Special stuff -------------------------------------------------*/
831 /** Scan options supported by the driver. */
832 SR_CONF_SCAN_OPTIONS = 40000,
834 /** Device options for a particular device. */
835 SR_CONF_DEVICE_OPTIONS,
837 /** Session filename. */
840 /** The device supports specifying a capturefile to inject. */
843 /** The device supports specifying the capturefile unit size. */
844 SR_CONF_CAPTURE_UNITSIZE,
846 /** Power off the device. */
850 * Data source for acquisition. If not present, acquisition from
851 * the device is always "live", i.e. acquisition starts when the
852 * frontend asks and the results are sent out as soon as possible.
854 * If present, it indicates that either the device has no live
855 * acquisition capability (for example a pure data logger), or
856 * there is a choice. sr_config_list() returns those choices.
858 * In any case if a device has live acquisition capabilities, it
859 * is always the default.
863 /*--- Acquisition modes ---------------------------------------------*/
866 * The device supports setting a sample time limit (how long
867 * the sample acquisition should run, in ms).
869 SR_CONF_LIMIT_MSEC = 50000,
872 * The device supports setting a sample number limit (how many
873 * samples should be acquired).
875 SR_CONF_LIMIT_SAMPLES,
878 * The device supports setting a frame limit (how many
879 * frames should be acquired).
881 SR_CONF_LIMIT_FRAMES,
884 * The device supports continuous sampling. Neither a time limit
885 * nor a sample number limit has to be supplied, it will just acquire
886 * samples continuously, until explicitly stopped by a certain command.
890 /** The device has internal storage, into which data is logged. This
891 * starts or stops the internal logging. */
894 /** Device mode for multi-function devices. */
897 /** Self test mode. */
901 /** Device instance data
904 /** Device driver. */
905 struct sr_dev_driver *driver;
906 /** Index of device in driver. */
908 /** Device instance status. SR_ST_NOT_FOUND, etc. */
910 /** Device instance type. SR_INST_USB, etc. */
912 /** Device vendor. */
916 /** Device version. */
918 /** List of channels. */
920 /** List of sr_channel_group structs */
921 GSList *channel_groups;
922 /** Device instance connection data (used?) */
924 /** Device instance private data (used?) */
928 /** Types of device instance, struct sr_dev_inst.type */
929 enum sr_dev_inst_type {
930 /** Device instance type for USB devices. */
932 /** Device instance type for serial port devices. */
934 /** Device instance type for SCPI devices. */
938 /** Device instance status, struct sr_dev_inst.status */
939 enum sr_dev_inst_status {
940 /** The device instance was not found. */
941 SR_ST_NOT_FOUND = 10000,
942 /** The device instance was found, but is still booting. */
944 /** The device instance is live, but not in use. */
946 /** The device instance is actively in use in a session. */
948 /** The device is winding down its session. */
952 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
953 struct sr_dev_driver {
954 /* Driver-specific */
955 /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
957 /** Long name. Verbose driver name shown to user. */
959 /** API version (currently 1). */
961 /** Called when driver is loaded, e.g. program startup. */
962 int (*init) (struct sr_context *sr_ctx);
963 /** Called before driver is unloaded.
964 * Driver must free all resouces held by it. */
965 int (*cleanup) (void);
966 /** Scan for devices. Driver should do all initialisation required.
967 * Can be called several times, e.g. with different port options.
968 * \retval NULL Error or no devices found.
969 * \retval other GSList of a struct sr_dev_inst for each device.
970 * Must be freed by caller!
972 GSList *(*scan) (GSList *options);
973 /** Get list of device instances the driver knows about.
974 * \returns NULL or GSList of a struct sr_dev_inst for each device.
975 * Must not be freed by caller!
977 GSList *(*dev_list) (void);
978 /** Clear list of devices the driver knows about. */
979 int (*dev_clear) (void);
980 /** Query value of a configuration key in driver or given device instance.
981 * @see sr_config_get().
983 int (*config_get) (int id, GVariant **data,
984 const struct sr_dev_inst *sdi,
985 const struct sr_channel_group *cg);
986 /** Set value of a configuration key in driver or a given device instance.
987 * @see sr_config_set(). */
988 int (*config_set) (int id, GVariant *data,
989 const struct sr_dev_inst *sdi,
990 const struct sr_channel_group *cg);
991 /** Channel status change.
992 * @see sr_dev_channel_enable(). */
993 int (*config_channel_set) (const struct sr_dev_inst *sdi,
994 struct sr_channel *ch, unsigned int changes);
995 /** Apply configuration settings to the device hardware.
996 * @see sr_config_commit().*/
997 int (*config_commit) (const struct sr_dev_inst *sdi);
998 /** List all possible values for a configuration key in a device instance.
999 * @see sr_config_list().
1001 int (*config_list) (int info_id, GVariant **data,
1002 const struct sr_dev_inst *sdi,
1003 const struct sr_channel_group *cg);
1005 /* Device-specific */
1007 int (*dev_open) (struct sr_dev_inst *sdi);
1009 int (*dev_close) (struct sr_dev_inst *sdi);
1010 /** Begin data acquisition on the specified device. */
1011 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
1013 /** End data acquisition on the specified device. */
1014 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
1018 /** Device driver private data. Initialized by init(). */
1023 * @struct sr_session
1025 * Opaque data structure representing a libsigrok session. None of the fields
1026 * of this structure are meant to be accessed directly.
1031 #include "version.h"