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 needs to be open. */
75 SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */
76 SR_ERR_PROBE_GROUP= -9, /**< A probe 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_PROBENAME_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_t)(int fd, int revents, void *cb_data);
137 /** Data types used by sr_config_info(). */
143 SR_T_RATIONAL_PERIOD,
150 /** Value for sr_datafeed_packet.type. */
152 /** Payload is sr_datafeed_header. */
153 SR_DF_HEADER = 10000,
154 /** End of stream (no further data). */
156 /** Payload is struct sr_datafeed_meta */
158 /** The trigger matched at this point in the data feed. No payload. */
160 /** Payload is struct sr_datafeed_logic. */
162 /** Payload is struct sr_datafeed_analog. */
164 /** Beginning of frame. No payload. */
166 /** End of frame. No payload. */
170 /** Measured quantity, sr_datafeed_analog.mq. */
172 SR_MQ_VOLTAGE = 10000,
178 /** Duty cycle, e.g. on/off ratio. */
180 /** Continuity test. */
184 /** Electrical power, usually in W, or dBm. */
186 /** Gain (a transistor's gain, or hFE, for example). */
188 /** Logarithmic representation of sound pressure relative to a
189 * reference value. */
190 SR_MQ_SOUND_PRESSURE_LEVEL,
191 /** Carbon monoxide level */
192 SR_MQ_CARBON_MONOXIDE,
194 SR_MQ_RELATIVE_HUMIDITY,
199 /** Unit of measured quantity, sr_datafeed_analog.unit. */
202 SR_UNIT_VOLT = 10000,
203 /** Ampere (current). */
205 /** Ohm (resistance). */
207 /** Farad (capacity). */
209 /** Kelvin (temperature). */
211 /** Degrees Celsius (temperature). */
213 /** Degrees Fahrenheit (temperature). */
215 /** Hertz (frequency, 1/s, [Hz]). */
217 /** Percent value. */
219 /** Boolean value. */
221 /** Time in seconds. */
223 /** Unit of conductance, the inverse of resistance. */
226 * An absolute measurement of power, in decibels, referenced to
230 /** Voltage in decibel, referenced to 1 volt (dBV). */
231 SR_UNIT_DECIBEL_VOLT,
233 * Measurements that intrinsically do not have units attached, such
234 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
235 * a unitless quantity, for example.
238 /** Sound pressure level relative so 20 micropascals. */
241 * Normalized (0 to 1) concentration of a substance or compound with 0
242 * representing a concentration of 0%, and 1 being 100%. This is
243 * represented as the fraction of number of particles of the substance.
245 SR_UNIT_CONCENTRATION,
246 /** Revolutions per minute. */
247 SR_UNIT_REVOLUTIONS_PER_MINUTE,
248 /** Apparent power [VA]. */
250 /** Real power [W]. */
252 /** Consumption [Wh]. */
256 /** Values for sr_datafeed_analog.flags. */
258 /** Voltage measurement is alternating current (AC). */
260 /** Voltage measurement is direct current (DC). */
262 /** This is a true RMS measurement. */
263 SR_MQFLAG_RMS = 0x04,
264 /** Value is voltage drop across a diode, or NAN. */
265 SR_MQFLAG_DIODE = 0x08,
266 /** Device is in "hold" mode (repeating the last measurement). */
267 SR_MQFLAG_HOLD = 0x10,
268 /** Device is in "max" mode, only updating upon a new max value. */
269 SR_MQFLAG_MAX = 0x20,
270 /** Device is in "min" mode, only updating upon a new min value. */
271 SR_MQFLAG_MIN = 0x40,
272 /** Device is in autoranging mode. */
273 SR_MQFLAG_AUTORANGE = 0x80,
274 /** Device is in relative mode. */
275 SR_MQFLAG_RELATIVE = 0x100,
276 /** Sound pressure level is A-weighted in the frequency domain,
277 * according to IEC 61672:2003. */
278 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
279 /** Sound pressure level is C-weighted in the frequency domain,
280 * according to IEC 61672:2003. */
281 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
282 /** Sound pressure level is Z-weighted (i.e. not at all) in the
283 * frequency domain, according to IEC 61672:2003. */
284 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
285 /** Sound pressure level is not weighted in the frequency domain,
286 * albeit without standards-defined low and high frequency limits. */
287 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
288 /** Sound pressure level measurement is S-weighted (1s) in the
290 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
291 /** Sound pressure level measurement is F-weighted (125ms) in the
293 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
294 /** Sound pressure level is time-averaged (LAT), also known as
295 * Equivalent Continuous A-weighted Sound Level (LEQ). */
296 SR_MQFLAG_SPL_LAT = 0x8000,
297 /** Sound pressure level represented as a percentage of measurements
298 * that were over a preset alarm level. */
299 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
300 /** Time is duration (as opposed to epoch, ...). */
301 SR_MQFLAG_DURATION = 0x20000,
302 /** Device is in "avg" mode, averaging upon each new value. */
303 SR_MQFLAG_AVG = 0x40000,
308 * Opaque structure representing a libsigrok context.
310 * None of the fields of this structure are meant to be accessed directly.
312 * @see sr_init(), sr_exit().
316 /** Packet in a sigrok data feed. */
317 struct sr_datafeed_packet {
322 /** Header of a sigrok data feed. */
323 struct sr_datafeed_header {
325 struct timeval starttime;
328 /** Datafeed payload for type SR_DF_META. */
329 struct sr_datafeed_meta {
333 /** Logic datafeed payload for type SR_DF_LOGIC. */
334 struct sr_datafeed_logic {
340 /** Analog datafeed payload for type SR_DF_ANALOG. */
341 struct sr_datafeed_analog {
342 /** The probes for which data is included in this packet. */
344 /** Number of samples in data */
346 /** Measured quantity (voltage, current, temperature, and so on).
347 * Use SR_MQ_VOLTAGE, ... */
349 /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
351 /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
353 /** The analog value(s). The data is interleaved according to
354 * the probes list. */
358 /** Input (file) format struct. */
361 * A pointer to this input format's 'struct sr_input_format'.
362 * The frontend can use this to call the module's callbacks.
364 struct sr_input_format *format;
368 struct sr_dev_inst *sdi;
373 /** Input (file) format driver. */
374 struct sr_input_format {
375 /** The unique ID for this input format. Must not be NULL. */
379 * A short description of the input format, which can (for example)
380 * be displayed to the user by frontends. Must not be NULL.
385 * Check if this input module can load and parse the specified file.
387 * @param[in] filename The name (and path) of the file to check.
389 * @retval TRUE This module knows the format.
390 * @retval FALSE This module does not know the format.
392 int (*format_match) (const char *filename);
395 * Initialize the input module.
397 * @param in A pointer to a valid 'struct sr_input' that the caller
398 * has to allocate and provide to this function. It is also
399 * the responsibility of the caller to free it later.
400 * @param[in] filename The name (and path) of the file to use.
402 * @retval SR_OK Success
403 * @retval other Negative error code.
405 int (*init) (struct sr_input *in, const char *filename);
408 * Load a file, parsing the input according to the file's format.
410 * This function will send datafeed packets to the session bus, so
411 * the calling frontend must have registered its session callbacks
414 * The packet types sent across the session bus by this function must
415 * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
416 * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
419 * @param in A pointer to a valid 'struct sr_input' that the caller
420 * has to allocate and provide to this function. It is also
421 * the responsibility of the caller to free it later.
422 * @param filename The name (and path) of the file to use.
424 * @retval SR_OK Success
425 * @retval other Negative error code.
427 int (*loadfile) (struct sr_input *in, const char *filename);
430 /** Output (file) format struct. */
433 * A pointer to this output format's 'struct sr_output_format'.
434 * The frontend can use this to call the module's callbacks.
436 struct sr_output_format *format;
439 * The device for which this output module is creating output. This
440 * can be used by the module to find out probe names and numbers.
442 struct sr_dev_inst *sdi;
445 * An optional parameter which the frontend can pass in to the
446 * output module. How the string is interpreted is entirely up to
452 * A generic pointer which can be used by the module to keep internal
453 * state between calls into its callback functions.
455 * For example, the module might store a pointer to a chunk of output
456 * there, and only flush it when it reaches a certain size.
461 /** Output (file) format driver. */
462 struct sr_output_format {
464 * A unique ID for this output format. Must not be NULL.
466 * It can be used by frontends to select this output format for use.
468 * For example, calling sigrok-cli with <code>-O hex</code> will
469 * select the hexadecimal text output format.
474 * A short description of the output format. Must not be NULL.
476 * This can be displayed by frontends, e.g. when selecting the output
477 * format for saving a file.
481 /** Datafeed type, SR_DF_HEADER, etc. */
485 * This function is called once, at the beginning of an output stream.
487 * The device struct will be available in the output struct passed in,
488 * as well as the param field -- which may be NULL or an empty string,
489 * if no parameter was passed.
491 * The module can use this to initialize itself, create a struct for
492 * keeping state and storing it in the <code>internal</code> field.
494 * @param o Pointer to the respective 'struct sr_output'.
496 * @retval SR_OK Success
497 * @retval other Negative error code.
499 int (*init) (struct sr_output *o);
502 * Whenever a chunk of data comes in, it will be passed to the
503 * output module via this function. The <code>data_in</code> and
504 * <code>length_in</code> values refers to this data; the module
505 * must not alter or g_free() this buffer.
507 * The function must allocate a buffer for storing its output, and
508 * pass along a pointer to this buffer in the <code>data_out</code>
509 * parameter, as well as storing the length of the buffer in
510 * <code>length_out</code>. The calling frontend will g_free()
511 * this buffer when it's done with it.
513 * IMPORTANT: The memory allocation much happen using a glib memory
514 * allocation call (not a "normal" malloc) since g_free() will be
515 * used to free the memory!
517 * If there is no output, this function MUST store NULL in the
518 * <code>data_out</code> parameter, so the caller knows not to try
521 * Note: This API call is obsolete, use receive() instead.
523 * @param o Pointer to the respective 'struct sr_output'.
524 * @param data_in Pointer to the input data buffer.
525 * @param length_in Length of the input.
526 * @param data_out Pointer to the allocated output buffer.
527 * @param length_out Length (in bytes) of the output.
529 * @retval SR_OK Success
530 * @retval other Negative error code.
532 int (*data) (struct sr_output *o, const uint8_t *data_in,
533 uint64_t length_in, uint8_t **data_out,
534 uint64_t *length_out);
537 * This function is called when an event occurs in the datafeed
538 * which the output module may need to be aware of. No data is
539 * passed in, only the fact that the event occurs. The following
540 * events can currently be passed in:
542 * - SR_DF_TRIGGER: At this point in the datafeed, the trigger
543 * matched. The output module may mark this in some way, e.g. by
544 * plotting a red line on a graph.
546 * - SR_DF_END: This marks the end of the datafeed. No more calls
547 * into the output module will be done, so this is a good time to
548 * free up any memory used to keep state, for example.
550 * Any output generated by this function must have a reference to
551 * it stored in the <code>data_out</code> and <code>length_out</code>
552 * parameters, or NULL if no output was generated.
554 * Note: This API call is obsolete, use receive() instead.
556 * @param o Pointer to the respective 'struct sr_output'.
557 * @param event_type Type of event that occured.
558 * @param data_out Pointer to the allocated output buffer.
559 * @param length_out Length (in bytes) of the output.
561 * @retval SR_OK Success
562 * @retval other Negative error code.
564 int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
565 uint64_t *length_out);
568 * This function is passed a copy of every packed in the data feed.
569 * Any output generated by the output module in response to the
570 * packet should be returned in a newly allocated GString
571 * <code>out</code>, which will be freed by the caller.
573 * Packets not of interest to the output module can just be ignored,
574 * and the <code>out</code> parameter set to NULL.
576 * @param o Pointer to the respective 'struct sr_output'.
577 * @param sdi The device instance that generated the packet.
578 * @param packet The complete packet.
579 * @param out A pointer where a GString * should be stored if
580 * the module generates output, or NULL if not.
582 * @retval SR_OK Success
583 * @retval other Negative error code.
585 int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi,
586 const struct sr_datafeed_packet *packet, GString **out);
589 * This function is called after the caller is finished using
590 * the output module, and can be used to free any internal
591 * resources the module may keep.
593 * @retval SR_OK Success
594 * @retval other Negative error code.
596 int (*cleanup) (struct sr_output *o);
599 /** Constants for probe type. */
601 /** Probe type is logic probe. */
602 SR_PROBE_LOGIC = 10000,
603 /** Probe type is analog probe. */
607 /** Information on single probe. */
609 /** Number of probes, starting at 0. @deprecated The index field
610 * will go: use g_slist_length(sdi->probes) instead. */
612 /** Probe type (SR_PROBE_LOGIC, ...) */
614 /** Is this probe enabled? */
616 /** Name of probe. */
618 /** Trigger string, format like used by sigrok-cli */
622 /** Structure for groups of probes that have common properties. */
623 struct sr_probe_group {
624 /** Name of the probe group. */
626 /** List of sr_probe structs of the probes belonging to this group. */
628 /** Private data for driver use. */
632 /** Used for setting or getting value of a config item. */
634 /** Config key like SR_CONF_CONN, etc. */
636 /** Key-specific data. */
640 /** Information about a config key. */
641 struct sr_config_info {
642 /** Config key like SR_CONF_CONN, etc. */
644 /** Data type like SR_T_CHAR, etc. */
646 /** Id string, e.g. "serialcomm". */
648 /** Name, e.g. "Serial communication". */
650 /** Verbose description (unused currently). */
654 /** Constants for device classes */
656 /*--- Device classes ------------------------------------------------*/
658 /** The device can act as logic analyzer. */
659 SR_CONF_LOGIC_ANALYZER = 10000,
661 /** The device can act as an oscilloscope. */
662 SR_CONF_OSCILLOSCOPE,
664 /** The device can act as a multimeter. */
667 /** The device is a demo device. */
670 /** The device can act as a sound level meter. */
671 SR_CONF_SOUNDLEVELMETER,
673 /** The device can measure temperature. */
676 /** The device can measure humidity. */
679 /** The device can measure energy consumption. */
682 /** The device can demodulate signals. */
685 /*--- Driver scan options -------------------------------------------*/
688 * Specification on how to connect to a device.
690 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
691 * the form which makes sense to the OS (e.g., /dev/ttyS0).
692 * Otherwise this specifies a USB device, either in the form of
693 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
694 * @verbatim <vendorid>.<productid> @endverbatim
695 * (hexadecimal, e.g. 1d6b.0001).
697 SR_CONF_CONN = 20000,
700 * Serial communication specification, in the form:
702 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
706 * The string may also be followed by one or more special settings,
707 * in the form "/key=value". Supported keys and their values are:
709 * rts 0,1 set the port's RTS pin to low or high
710 * dtr 0,1 set the port's DTR pin to low or high
711 * flow 0 no flow control
712 * 1 hardware-based (RTS/CTS) flow control
713 * 2 software-based (XON/XOFF) flow control
715 * This is always an optional parameter, since a driver typically
716 * knows the speed at which the device wants to communicate.
720 /*--- Device configuration ------------------------------------------*/
722 /** The device supports setting its samplerate, in Hz. */
723 SR_CONF_SAMPLERATE = 30000,
725 /** The device supports setting a pre/post-trigger capture ratio. */
726 SR_CONF_CAPTURE_RATIO,
728 /** The device supports setting a pattern (pattern generator mode). */
729 SR_CONF_PATTERN_MODE,
731 /** The device supports Run Length Encoding. */
734 /** The device supports setting trigger slope. */
735 SR_CONF_TRIGGER_SLOPE,
737 /** Trigger source. */
738 SR_CONF_TRIGGER_SOURCE,
740 /** Horizontal trigger position. */
741 SR_CONF_HORIZ_TRIGGERPOS,
758 /** Trigger types. */
759 SR_CONF_TRIGGER_TYPE,
761 /** The device supports setting its sample interval, in ms. */
762 SR_CONF_SAMPLE_INTERVAL,
764 /** Number of timebases, as related to SR_CONF_TIMEBASE. */
765 SR_CONF_NUM_TIMEBASE,
767 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
770 /** Sound pressure level frequency weighting. */
771 SR_CONF_SPL_WEIGHT_FREQ,
773 /** Sound pressure level time weighting. */
774 SR_CONF_SPL_WEIGHT_TIME,
776 /** Sound pressure level measurement range. */
777 SR_CONF_SPL_MEASUREMENT_RANGE,
779 /** Max hold mode. */
782 /** Min hold mode. */
785 /** Logic low-high threshold range. */
786 SR_CONF_VOLTAGE_THRESHOLD,
788 /** The device supports using a external clock. */
789 SR_CONF_EXTERNAL_CLOCK,
792 * The device supports swapping channels. Typical this is between
793 * buffered and unbuffered channels.
797 /** Center frequency.
798 * The input signal is downmixed by this frequency before the ADC
799 * anti-aliasing filter.
801 SR_CONF_CENTER_FREQUENCY,
803 /*--- Special stuff -------------------------------------------------*/
805 /** Scan options supported by the driver. */
806 SR_CONF_SCAN_OPTIONS = 40000,
808 /** Device options for a particular device. */
809 SR_CONF_DEVICE_OPTIONS,
811 /** Session filename. */
814 /** The device supports specifying a capturefile to inject. */
817 /** The device supports specifying the capturefile unit size. */
818 SR_CONF_CAPTURE_UNITSIZE,
820 /** The device supports setting the number of probes. */
821 SR_CONF_CAPTURE_NUM_PROBES,
823 /** Power off the device. */
826 /** Data source for acquisition. If not present, acquisition from
827 * the device is always "live", i.e. acquisition starts when the
828 * frontend asks and the results are sent out as soon as possible.
830 * If present, it indicates that either the device has no live
831 * acquisition capability (for example a pure data logger), or
832 * there is a choice. sr_config_list() returns those choices.
834 * In any case if a device has live acquisition capabilities, it
835 * is always the default. */
838 /*--- Acquisition modes ---------------------------------------------*/
841 * The device supports setting a sample time limit (how long
842 * the sample acquisition should run, in ms).
844 SR_CONF_LIMIT_MSEC = 50000,
847 * The device supports setting a sample number limit (how many
848 * samples should be acquired).
850 SR_CONF_LIMIT_SAMPLES,
853 * The device supports setting a frame limit (how many
854 * frames should be acquired).
856 SR_CONF_LIMIT_FRAMES,
859 * The device supports continuous sampling. Neither a time limit
860 * nor a sample number limit has to be supplied, it will just acquire
861 * samples continuously, until explicitly stopped by a certain command.
865 /** The device has internal storage, into which data is logged. This
866 * starts or stops the internal logging. */
870 /** Device instance data
873 /** Device driver. */
874 struct sr_dev_driver *driver;
875 /** Index of device in driver. */
877 /** Device instance status. SR_ST_NOT_FOUND, etc. */
879 /** Device instance type. SR_INST_USB, etc. */
881 /** Device vendor. */
885 /** Device version. */
887 /** List of probes. */
889 /** List of sr_probe_group structs */
890 GSList *probe_groups;
891 /** Device instance connection data (used?) */
893 /** Device instance private data (used?) */
897 /** Types of device instance, struct sr_dev_inst.type */
899 /** Device instance type for USB devices. */
901 /** Device instance type for serial port devices. */
903 /** Device instance type for SCPI devices. */
907 /** Device instance status, struct sr_dev_inst.status */
909 /** The device instance was not found. */
910 SR_ST_NOT_FOUND = 10000,
911 /** The device instance was found, but is still booting. */
913 /** The device instance is live, but not in use. */
915 /** The device instance is actively in use in a session. */
917 /** The device is winding down its session. */
921 /** Device driver data */
922 struct sr_dev_driver {
923 /* Driver-specific */
926 /** Long name, e.g. device name. */
928 /** API version (currently 1). */
931 int (*init) (struct sr_context *sr_ctx);
933 int (*cleanup) (void);
934 /** Scan for devices */
935 GSList *(*scan) (GSList *options);
936 /** Get device list */
937 GSList *(*dev_list) (void);
938 int (*dev_clear) (void);
939 int (*config_get) (int id, GVariant **data,
940 const struct sr_dev_inst *sdi,
941 const struct sr_probe_group *probe_group);
942 int (*config_set) (int id, GVariant *data,
943 const struct sr_dev_inst *sdi,
944 const struct sr_probe_group *probe_group);
945 int (*config_list) (int info_id, GVariant **data,
946 const struct sr_dev_inst *sdi,
947 const struct sr_probe_group *probe_group);
949 /* Device-specific */
951 int (*dev_open) (struct sr_dev_inst *sdi);
953 int (*dev_close) (struct sr_dev_inst *sdi);
954 /** Start data aquisition. */
955 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
957 /** Stop data aquisition. */
958 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
962 /** Device driver private data */
969 * Opaque data structure representing a libsigrok session. None of the fields
970 * of this structure are meant to be accessed directly.