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, in decibels, relative to 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,
307 enum sr_trigger_matches {
317 /** The representation of a trigger, consisting of one or more stages
318 * containing one or more matches on a channel.
321 /** A name for this trigger. This may be NULL if none is needed. */
323 /** List of pointers to struct sr_trigger_stage. */
327 /** A trigger stage. */
328 struct sr_trigger_stage {
331 /** List of pointers to struct sr_trigger_match. */
335 /** A channel to match and what to match it on. */
336 struct sr_trigger_match {
337 /** The channel to trigger on. */
338 struct sr_channel *channel;
339 /** The trigger match to use.
340 * For logic channels, only the following matches may be used:
347 * For analog channels, only these matches may be used:
355 /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
356 * this contains the value to compare against. */
362 * Opaque structure representing a libsigrok context.
364 * None of the fields of this structure are meant to be accessed directly.
366 * @see sr_init(), sr_exit().
370 /** Packet in a sigrok data feed. */
371 struct sr_datafeed_packet {
376 /** Header of a sigrok data feed. */
377 struct sr_datafeed_header {
379 struct timeval starttime;
382 /** Datafeed payload for type SR_DF_META. */
383 struct sr_datafeed_meta {
387 /** Logic datafeed payload for type SR_DF_LOGIC. */
388 struct sr_datafeed_logic {
394 /** Analog datafeed payload for type SR_DF_ANALOG. */
395 struct sr_datafeed_analog {
396 /** The channels for which data is included in this packet. */
398 /** Number of samples in data */
400 /** Measured quantity (voltage, current, temperature, and so on).
401 * Use SR_MQ_VOLTAGE, ... */
403 /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
405 /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
407 /** The analog value(s). The data is interleaved according to
408 * the channels list. */
412 /** Input (file) format struct. */
415 * A pointer to this input format's 'struct sr_input_format'.
416 * The frontend can use this to call the module's callbacks.
418 struct sr_input_format *format;
422 struct sr_dev_inst *sdi;
427 /** Input (file) format driver. */
428 struct sr_input_format {
429 /** The unique ID for this input format. Must not be NULL. */
433 * A short description of the input format, which can (for example)
434 * be displayed to the user by frontends. Must not be NULL.
439 * Check if this input module can load and parse the specified file.
441 * @param[in] filename The name (and path) of the file to check.
443 * @retval TRUE This module knows the format.
444 * @retval FALSE This module does not know the format.
446 int (*format_match) (const char *filename);
449 * Initialize the input module.
451 * @param in A pointer to a valid 'struct sr_input' that the caller
452 * has to allocate and provide to this function. It is also
453 * the responsibility of the caller to free it later.
454 * @param[in] filename The name (and path) of the file to use.
456 * @retval SR_OK Success
457 * @retval other Negative error code.
459 int (*init) (struct sr_input *in, const char *filename);
462 * Load a file, parsing the input according to the file's format.
464 * This function will send datafeed packets to the session bus, so
465 * the calling frontend must have registered its session callbacks
468 * The packet types sent across the session bus by this function must
469 * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
470 * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
473 * @param in A pointer to a valid 'struct sr_input' that the caller
474 * has to allocate and provide to this function. It is also
475 * the responsibility of the caller to free it later.
476 * @param filename The name (and path) of the file to use.
478 * @retval SR_OK Success
479 * @retval other Negative error code.
481 int (*loadfile) (struct sr_input *in, const char *filename);
484 /** Output (file) format struct. */
486 /** A pointer to this output's format. */
487 struct sr_output_format *format;
490 * The device for which this output module is creating output. This
491 * can be used by the module to find out channel names and numbers.
493 const struct sr_dev_inst *sdi;
496 * An optional parameter which the frontend can pass in to the
497 * output module. How the string is interpreted is entirely up to
503 * A generic pointer which can be used by the module to keep internal
504 * state between calls into its callback functions.
506 * For example, the module might store a pointer to a chunk of output
507 * there, and only flush it when it reaches a certain size.
512 /** Output (file) format driver. */
513 struct sr_output_format {
515 * A unique ID for this output format. Must not be NULL.
517 * It can be used by frontends to select this output format for use.
519 * For example, calling sigrok-cli with <code>-O hex</code> will
520 * select the hexadecimal text output format.
525 * A short description of the output format. Must not be NULL.
527 * This can be displayed by frontends, e.g. when selecting the output
528 * format for saving a file.
533 * This function is called once, at the beginning of an output stream.
535 * The device struct will be available in the output struct passed in,
536 * as well as the param field -- which may be NULL or an empty string,
537 * if no parameter was passed.
539 * The module can use this to initialize itself, create a struct for
540 * keeping state and storing it in the <code>internal</code> field.
542 * @param o Pointer to the respective 'struct sr_output'.
544 * @retval SR_OK Success
545 * @retval other Negative error code.
547 int (*init) (struct sr_output *o);
550 * This function is passed a copy of every packed in the data feed.
551 * Any output generated by the output module in response to the
552 * packet should be returned in a newly allocated GString
553 * <code>out</code>, which will be freed by the caller.
555 * Packets not of interest to the output module can just be ignored,
556 * and the <code>out</code> parameter set to NULL.
558 * @param o Pointer to the respective 'struct sr_output'.
559 * @param sdi The device instance that generated the packet.
560 * @param packet The complete packet.
561 * @param out A pointer where a GString * should be stored if
562 * the module generates output, or NULL if not.
564 * @retval SR_OK Success
565 * @retval other Negative error code.
567 int (*receive) (struct sr_output *o,
568 const struct sr_datafeed_packet *packet, GString **out);
571 * This function is called after the caller is finished using
572 * the output module, and can be used to free any internal
573 * resources the module may keep.
575 * @retval SR_OK Success
576 * @retval other Negative error code.
578 int (*cleanup) (struct sr_output *o);
581 /** Constants for channel type. */
582 enum sr_channeltype {
583 /** Channel type is logic channel. */
584 SR_CHANNEL_LOGIC = 10000,
585 /** Channel type is analog channel. */
589 /** Information on single channel. */
591 /** The index of this channel, starting at 0. Logic channels will
592 * be encoded according to this index in SR_DF_LOGIC packets. */
594 /** Channel type (SR_CHANNEL_LOGIC, ...) */
596 /** Is this channel enabled? */
598 /** Name of channel. */
602 /** Structure for groups of channels that have common properties. */
603 struct sr_channel_group {
604 /** Name of the channel group. */
606 /** List of sr_channel structs of the channels belonging to this group. */
608 /** Private data for driver use. */
612 /** Used for setting or getting value of a config item. */
614 /** Config key like SR_CONF_CONN, etc. */
616 /** Key-specific data. */
620 /** Information about a config key. */
621 struct sr_config_info {
622 /** Config key like SR_CONF_CONN, etc. */
624 /** Data type like SR_T_STRING, etc. */
626 /** Id string, e.g. "serialcomm". */
628 /** Name, e.g. "Serial communication". */
630 /** Verbose description (unused currently). */
634 /** Constants for device classes */
636 /*--- Device classes ------------------------------------------------*/
638 /** The device can act as logic analyzer. */
639 SR_CONF_LOGIC_ANALYZER = 10000,
641 /** The device can act as an oscilloscope. */
642 SR_CONF_OSCILLOSCOPE,
644 /** The device can act as a multimeter. */
647 /** The device is a demo device. */
650 /** The device can act as a sound level meter. */
651 SR_CONF_SOUNDLEVELMETER,
653 /** The device can measure temperature. */
656 /** The device can measure humidity. */
659 /** The device can measure energy consumption. */
662 /** The device can demodulate signals. */
665 /** Programmable power supply. */
666 SR_CONF_POWER_SUPPLY,
668 /*--- Driver scan options -------------------------------------------*/
671 * Specification on how to connect to a device.
673 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
674 * the form which makes sense to the OS (e.g., /dev/ttyS0).
675 * Otherwise this specifies a USB device, either in the form of
676 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
677 * @verbatim <vendorid>.<productid> @endverbatim
678 * (hexadecimal, e.g. 1d6b.0001).
680 SR_CONF_CONN = 20000,
683 * Serial communication specification, in the form:
685 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
689 * The string may also be followed by one or more special settings,
690 * in the form "/key=value". Supported keys and their values are:
692 * rts 0,1 set the port's RTS pin to low or high
693 * dtr 0,1 set the port's DTR pin to low or high
694 * flow 0 no flow control
695 * 1 hardware-based (RTS/CTS) flow control
696 * 2 software-based (XON/XOFF) flow control
698 * This is always an optional parameter, since a driver typically
699 * knows the speed at which the device wants to communicate.
703 /*--- Device configuration ------------------------------------------*/
705 /** The device supports setting its samplerate, in Hz. */
706 SR_CONF_SAMPLERATE = 30000,
708 /** The device supports setting a pre/post-trigger capture ratio. */
709 SR_CONF_CAPTURE_RATIO,
711 /** The device supports setting a pattern (pattern generator mode). */
712 SR_CONF_PATTERN_MODE,
714 /** The device supports Run Length Encoding. */
717 /** The device supports setting trigger slope. */
718 SR_CONF_TRIGGER_SLOPE,
720 /** Trigger source. */
721 SR_CONF_TRIGGER_SOURCE,
723 /** Horizontal trigger position. */
724 SR_CONF_HORIZ_TRIGGERPOS,
741 /** Trigger matches. */
742 SR_CONF_TRIGGER_MATCH,
744 /** The device supports setting its sample interval, in ms. */
745 SR_CONF_SAMPLE_INTERVAL,
747 /** Number of timebases, as related to SR_CONF_TIMEBASE. */
748 SR_CONF_NUM_TIMEBASE,
750 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
753 /** Sound pressure level frequency weighting. */
754 SR_CONF_SPL_WEIGHT_FREQ,
756 /** Sound pressure level time weighting. */
757 SR_CONF_SPL_WEIGHT_TIME,
759 /** Sound pressure level measurement range. */
760 SR_CONF_SPL_MEASUREMENT_RANGE,
762 /** Max hold mode. */
765 /** Min hold mode. */
768 /** Logic low-high threshold range. */
769 SR_CONF_VOLTAGE_THRESHOLD,
771 /** The device supports using an external clock. */
772 SR_CONF_EXTERNAL_CLOCK,
775 * The device supports swapping channels. Typical this is between
776 * buffered and unbuffered channels.
780 /** Center frequency.
781 * The input signal is downmixed by this frequency before the ADC
782 * anti-aliasing filter.
784 SR_CONF_CENTER_FREQUENCY,
786 /** The device supports setting the number of logic channels. */
787 SR_CONF_NUM_LOGIC_CHANNELS,
789 /** The device supports setting the number of analog channels. */
790 SR_CONF_NUM_ANALOG_CHANNELS,
792 /** Output voltage. */
793 SR_CONF_OUTPUT_VOLTAGE,
795 /** Maximum output voltage. */
796 SR_CONF_OUTPUT_VOLTAGE_MAX,
798 /** Output current. */
799 SR_CONF_OUTPUT_CURRENT,
801 /** Maximum output current. */
802 SR_CONF_OUTPUT_CURRENT_MAX,
804 /** Enabling/disabling output. */
805 SR_CONF_OUTPUT_ENABLED,
807 /** Channel output configuration. */
808 SR_CONF_OUTPUT_CHANNEL,
810 /** Over-voltage protection (OVP) */
811 SR_CONF_OVER_VOLTAGE_PROTECTION,
813 /** Over-current protection (OCP) */
814 SR_CONF_OVER_CURRENT_PROTECTION,
816 /** Choice of clock edge for external clock ("r" or "f"). */
819 /*--- Special stuff -------------------------------------------------*/
821 /** Scan options supported by the driver. */
822 SR_CONF_SCAN_OPTIONS = 40000,
824 /** Device options for a particular device. */
825 SR_CONF_DEVICE_OPTIONS,
827 /** Session filename. */
830 /** The device supports specifying a capturefile to inject. */
833 /** The device supports specifying the capturefile unit size. */
834 SR_CONF_CAPTURE_UNITSIZE,
836 /** Power off the device. */
840 * Data source for acquisition. If not present, acquisition from
841 * the device is always "live", i.e. acquisition starts when the
842 * frontend asks and the results are sent out as soon as possible.
844 * If present, it indicates that either the device has no live
845 * acquisition capability (for example a pure data logger), or
846 * there is a choice. sr_config_list() returns those choices.
848 * In any case if a device has live acquisition capabilities, it
849 * is always the default.
853 /*--- Acquisition modes ---------------------------------------------*/
856 * The device supports setting a sample time limit (how long
857 * the sample acquisition should run, in ms).
859 SR_CONF_LIMIT_MSEC = 50000,
862 * The device supports setting a sample number limit (how many
863 * samples should be acquired).
865 SR_CONF_LIMIT_SAMPLES,
868 * The device supports setting a frame limit (how many
869 * frames should be acquired).
871 SR_CONF_LIMIT_FRAMES,
874 * The device supports continuous sampling. Neither a time limit
875 * nor a sample number limit has to be supplied, it will just acquire
876 * samples continuously, until explicitly stopped by a certain command.
880 /** The device has internal storage, into which data is logged. This
881 * starts or stops the internal logging. */
884 /** Device mode for multi-function devices. */
887 /** Self test mode. */
891 /** Device instance data
894 /** Device driver. */
895 struct sr_dev_driver *driver;
896 /** Index of device in driver. */
898 /** Device instance status. SR_ST_NOT_FOUND, etc. */
900 /** Device instance type. SR_INST_USB, etc. */
902 /** Device vendor. */
906 /** Device version. */
908 /** List of channels. */
910 /** List of sr_channel_group structs */
911 GSList *channel_groups;
912 /** Device instance connection data (used?) */
914 /** Device instance private data (used?) */
918 /** Types of device instance, struct sr_dev_inst.type */
919 enum sr_dev_inst_type {
920 /** Device instance type for USB devices. */
922 /** Device instance type for serial port devices. */
924 /** Device instance type for SCPI devices. */
928 /** Device instance status, struct sr_dev_inst.status */
929 enum sr_dev_inst_status {
930 /** The device instance was not found. */
931 SR_ST_NOT_FOUND = 10000,
932 /** The device instance was found, but is still booting. */
934 /** The device instance is live, but not in use. */
936 /** The device instance is actively in use in a session. */
938 /** The device is winding down its session. */
942 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
943 struct sr_dev_driver {
944 /* Driver-specific */
945 /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
947 /** Long name. Verbose driver name shown to user. */
949 /** API version (currently 1). */
951 /** Called when driver is loaded, e.g. program startup. */
952 int (*init) (struct sr_context *sr_ctx);
953 /** Called before driver is unloaded.
954 * Driver must free all resouces held by it. */
955 int (*cleanup) (void);
956 /** Scan for devices. Driver should do all initialisation required.
957 * Can be called several times, e.g. with different port options.
958 * \retval NULL Error or no devices found.
959 * \retval other GSList of a struct sr_dev_inst for each device.
960 * Must be freed by caller!
962 GSList *(*scan) (GSList *options);
963 /** Get list of device instances the driver knows about.
964 * \returns NULL or GSList of a struct sr_dev_inst for each device.
965 * Must not be freed by caller!
967 GSList *(*dev_list) (void);
968 /** Clear list of devices the driver knows about. */
969 int (*dev_clear) (void);
970 /** Query value of a configuration key in driver or given device instance.
971 * @see sr_config_get().
973 int (*config_get) (int id, GVariant **data,
974 const struct sr_dev_inst *sdi,
975 const struct sr_channel_group *cg);
976 /** Set value of a configuration key in driver or a given device instance.
977 * @see sr_config_set(). */
978 int (*config_set) (int id, GVariant *data,
979 const struct sr_dev_inst *sdi,
980 const struct sr_channel_group *cg);
981 /** Channel status change.
982 * @see sr_dev_channel_enable(). */
983 int (*config_channel_set) (const struct sr_dev_inst *sdi,
984 struct sr_channel *ch, unsigned int changes);
985 /** Apply configuration settings to the device hardware.
986 * @see sr_config_commit().*/
987 int (*config_commit) (const struct sr_dev_inst *sdi);
988 /** List all possible values for a configuration key in a device instance.
989 * @see sr_config_list().
991 int (*config_list) (int info_id, GVariant **data,
992 const struct sr_dev_inst *sdi,
993 const struct sr_channel_group *cg);
995 /* Device-specific */
997 int (*dev_open) (struct sr_dev_inst *sdi);
999 int (*dev_close) (struct sr_dev_inst *sdi);
1000 /** Begin data acquisition on the specified device. */
1001 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
1003 /** End data acquisition on the specified device. */
1004 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
1008 /** Device driver private data. Initialized by init(). */
1013 * @struct sr_session
1015 * Opaque data structure representing a libsigrok session. None of the fields
1016 * of this structure are meant to be accessed directly.
1021 #include "version.h"