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,
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 relative so 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,
309 * Opaque structure representing a libsigrok context.
311 * None of the fields of this structure are meant to be accessed directly.
313 * @see sr_init(), sr_exit().
317 /** Packet in a sigrok data feed. */
318 struct sr_datafeed_packet {
323 /** Header of a sigrok data feed. */
324 struct sr_datafeed_header {
326 struct timeval starttime;
329 /** Datafeed payload for type SR_DF_META. */
330 struct sr_datafeed_meta {
334 /** Logic datafeed payload for type SR_DF_LOGIC. */
335 struct sr_datafeed_logic {
341 /** Analog datafeed payload for type SR_DF_ANALOG. */
342 struct sr_datafeed_analog {
343 /** The probes for which data is included in this packet. */
345 /** Number of samples in data */
347 /** Measured quantity (voltage, current, temperature, and so on).
348 * Use SR_MQ_VOLTAGE, ... */
350 /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
352 /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
354 /** The analog value(s). The data is interleaved according to
355 * the probes list. */
359 /** Input (file) format struct. */
362 * A pointer to this input format's 'struct sr_input_format'.
363 * The frontend can use this to call the module's callbacks.
365 struct sr_input_format *format;
369 struct sr_dev_inst *sdi;
374 /** Input (file) format driver. */
375 struct sr_input_format {
376 /** The unique ID for this input format. Must not be NULL. */
380 * A short description of the input format, which can (for example)
381 * be displayed to the user by frontends. Must not be NULL.
386 * Check if this input module can load and parse the specified file.
388 * @param[in] filename The name (and path) of the file to check.
390 * @retval TRUE This module knows the format.
391 * @retval FALSE This module does not know the format.
393 int (*format_match) (const char *filename);
396 * Initialize the input module.
398 * @param in A pointer to a valid 'struct sr_input' that the caller
399 * has to allocate and provide to this function. It is also
400 * the responsibility of the caller to free it later.
401 * @param[in] filename The name (and path) of the file to use.
403 * @retval SR_OK Success
404 * @retval other Negative error code.
406 int (*init) (struct sr_input *in, const char *filename);
409 * Load a file, parsing the input according to the file's format.
411 * This function will send datafeed packets to the session bus, so
412 * the calling frontend must have registered its session callbacks
415 * The packet types sent across the session bus by this function must
416 * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
417 * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
420 * @param in A pointer to a valid 'struct sr_input' that the caller
421 * has to allocate and provide to this function. It is also
422 * the responsibility of the caller to free it later.
423 * @param filename The name (and path) of the file to use.
425 * @retval SR_OK Success
426 * @retval other Negative error code.
428 int (*loadfile) (struct sr_input *in, const char *filename);
431 /** Output (file) format struct. */
434 * A pointer to this output format's 'struct sr_output_format'.
435 * The frontend can use this to call the module's callbacks.
437 struct sr_output_format *format;
440 * The device for which this output module is creating output. This
441 * can be used by the module to find out probe names and numbers.
443 struct sr_dev_inst *sdi;
446 * An optional parameter which the frontend can pass in to the
447 * output module. How the string is interpreted is entirely up to
453 * A generic pointer which can be used by the module to keep internal
454 * state between calls into its callback functions.
456 * For example, the module might store a pointer to a chunk of output
457 * there, and only flush it when it reaches a certain size.
462 /** Output (file) format driver. */
463 struct sr_output_format {
465 * A unique ID for this output format. Must not be NULL.
467 * It can be used by frontends to select this output format for use.
469 * For example, calling sigrok-cli with <code>-O hex</code> will
470 * select the hexadecimal text output format.
475 * A short description of the output format. Must not be NULL.
477 * This can be displayed by frontends, e.g. when selecting the output
478 * format for saving a file.
482 /** Datafeed type, SR_DF_HEADER, etc. */
486 * This function is called once, at the beginning of an output stream.
488 * The device struct will be available in the output struct passed in,
489 * as well as the param field -- which may be NULL or an empty string,
490 * if no parameter was passed.
492 * The module can use this to initialize itself, create a struct for
493 * keeping state and storing it in the <code>internal</code> field.
495 * @param o Pointer to the respective 'struct sr_output'.
497 * @retval SR_OK Success
498 * @retval other Negative error code.
500 int (*init) (struct sr_output *o);
503 * Whenever a chunk of data comes in, it will be passed to the
504 * output module via this function. The <code>data_in</code> and
505 * <code>length_in</code> values refers to this data; the module
506 * must not alter or g_free() this buffer.
508 * The function must allocate a buffer for storing its output, and
509 * pass along a pointer to this buffer in the <code>data_out</code>
510 * parameter, as well as storing the length of the buffer in
511 * <code>length_out</code>. The calling frontend will g_free()
512 * this buffer when it's done with it.
514 * IMPORTANT: The memory allocation much happen using a glib memory
515 * allocation call (not a "normal" malloc) since g_free() will be
516 * used to free the memory!
518 * If there is no output, this function MUST store NULL in the
519 * <code>data_out</code> parameter, so the caller knows not to try
522 * Note: This API call is obsolete, use receive() instead.
524 * @param o Pointer to the respective 'struct sr_output'.
525 * @param data_in Pointer to the input data buffer.
526 * @param length_in Length of the input.
527 * @param data_out Pointer to the allocated output buffer.
528 * @param length_out Length (in bytes) of the output.
530 * @retval SR_OK Success
531 * @retval other Negative error code.
533 int (*data) (struct sr_output *o, const uint8_t *data_in,
534 uint64_t length_in, uint8_t **data_out,
535 uint64_t *length_out);
538 * This function is called when an event occurs in the datafeed
539 * which the output module may need to be aware of. No data is
540 * passed in, only the fact that the event occurs. The following
541 * events can currently be passed in:
543 * - SR_DF_TRIGGER: At this point in the datafeed, the trigger
544 * matched. The output module may mark this in some way, e.g. by
545 * plotting a red line on a graph.
547 * - SR_DF_END: This marks the end of the datafeed. No more calls
548 * into the output module will be done, so this is a good time to
549 * free up any memory used to keep state, for example.
551 * Any output generated by this function must have a reference to
552 * it stored in the <code>data_out</code> and <code>length_out</code>
553 * parameters, or NULL if no output was generated.
555 * Note: This API call is obsolete, use receive() instead.
557 * @param o Pointer to the respective 'struct sr_output'.
558 * @param event_type Type of event that occured.
559 * @param data_out Pointer to the allocated output buffer.
560 * @param length_out Length (in bytes) of the output.
562 * @retval SR_OK Success
563 * @retval other Negative error code.
565 int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
566 uint64_t *length_out);
569 * This function is passed a copy of every packed in the data feed.
570 * Any output generated by the output module in response to the
571 * packet should be returned in a newly allocated GString
572 * <code>out</code>, which will be freed by the caller.
574 * Packets not of interest to the output module can just be ignored,
575 * and the <code>out</code> parameter set to NULL.
577 * @param o Pointer to the respective 'struct sr_output'.
578 * @param sdi The device instance that generated the packet.
579 * @param packet The complete packet.
580 * @param out A pointer where a GString * should be stored if
581 * the module generates output, or NULL if not.
583 * @retval SR_OK Success
584 * @retval other Negative error code.
586 int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi,
587 const struct sr_datafeed_packet *packet, GString **out);
590 * This function is called after the caller is finished using
591 * the output module, and can be used to free any internal
592 * resources the module may keep.
594 * @retval SR_OK Success
595 * @retval other Negative error code.
597 int (*cleanup) (struct sr_output *o);
600 /** Constants for probe type. */
602 /** Probe type is logic probe. */
603 SR_PROBE_LOGIC = 10000,
604 /** Probe type is analog probe. */
608 /** Information on single probe. */
610 /** Number of probes, starting at 0. @deprecated The index field
611 * will go: use g_slist_length(sdi->probes) instead. */
613 /** Probe type (SR_PROBE_LOGIC, ...) */
615 /** Is this probe enabled? */
617 /** Name of probe. */
619 /** Trigger string, format like used by sigrok-cli */
623 /** Structure for groups of probes that have common properties. */
624 struct sr_probe_group {
625 /** Name of the probe group. */
627 /** List of sr_probe structs of the probes belonging to this group. */
629 /** Private data for driver use. */
633 /** Used for setting or getting value of a config item. */
635 /** Config key like SR_CONF_CONN, etc. */
637 /** Key-specific data. */
641 /** Information about a config key. */
642 struct sr_config_info {
643 /** Config key like SR_CONF_CONN, etc. */
645 /** Data type like SR_T_CHAR, etc. */
647 /** Id string, e.g. "serialcomm". */
649 /** Name, e.g. "Serial communication". */
651 /** Verbose description (unused currently). */
655 /** Constants for device classes */
657 /*--- Device classes ------------------------------------------------*/
659 /** The device can act as logic analyzer. */
660 SR_CONF_LOGIC_ANALYZER = 10000,
662 /** The device can act as an oscilloscope. */
663 SR_CONF_OSCILLOSCOPE,
665 /** The device can act as a multimeter. */
668 /** The device is a demo device. */
671 /** The device can act as a sound level meter. */
672 SR_CONF_SOUNDLEVELMETER,
674 /** The device can measure temperature. */
677 /** The device can measure humidity. */
680 /** The device can measure energy consumption. */
683 /** The device can demodulate signals. */
686 /** Programmable power supply. */
687 SR_CONF_POWER_SUPPLY,
689 /*--- Driver scan options -------------------------------------------*/
692 * Specification on how to connect to a device.
694 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
695 * the form which makes sense to the OS (e.g., /dev/ttyS0).
696 * Otherwise this specifies a USB device, either in the form of
697 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
698 * @verbatim <vendorid>.<productid> @endverbatim
699 * (hexadecimal, e.g. 1d6b.0001).
701 SR_CONF_CONN = 20000,
704 * Serial communication specification, in the form:
706 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
710 * The string may also be followed by one or more special settings,
711 * in the form "/key=value". Supported keys and their values are:
713 * rts 0,1 set the port's RTS pin to low or high
714 * dtr 0,1 set the port's DTR pin to low or high
715 * flow 0 no flow control
716 * 1 hardware-based (RTS/CTS) flow control
717 * 2 software-based (XON/XOFF) flow control
719 * This is always an optional parameter, since a driver typically
720 * knows the speed at which the device wants to communicate.
724 /*--- Device configuration ------------------------------------------*/
726 /** The device supports setting its samplerate, in Hz. */
727 SR_CONF_SAMPLERATE = 30000,
729 /** The device supports setting a pre/post-trigger capture ratio. */
730 SR_CONF_CAPTURE_RATIO,
732 /** The device supports setting a pattern (pattern generator mode). */
733 SR_CONF_PATTERN_MODE,
735 /** The device supports Run Length Encoding. */
738 /** The device supports setting trigger slope. */
739 SR_CONF_TRIGGER_SLOPE,
741 /** Trigger source. */
742 SR_CONF_TRIGGER_SOURCE,
744 /** Horizontal trigger position. */
745 SR_CONF_HORIZ_TRIGGERPOS,
762 /** Trigger types. */
763 SR_CONF_TRIGGER_TYPE,
765 /** The device supports setting its sample interval, in ms. */
766 SR_CONF_SAMPLE_INTERVAL,
768 /** Number of timebases, as related to SR_CONF_TIMEBASE. */
769 SR_CONF_NUM_TIMEBASE,
771 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
774 /** Sound pressure level frequency weighting. */
775 SR_CONF_SPL_WEIGHT_FREQ,
777 /** Sound pressure level time weighting. */
778 SR_CONF_SPL_WEIGHT_TIME,
780 /** Sound pressure level measurement range. */
781 SR_CONF_SPL_MEASUREMENT_RANGE,
783 /** Max hold mode. */
786 /** Min hold mode. */
789 /** Logic low-high threshold range. */
790 SR_CONF_VOLTAGE_THRESHOLD,
792 /** The device supports using an external clock. */
793 SR_CONF_EXTERNAL_CLOCK,
796 * The device supports swapping channels. Typical this is between
797 * buffered and unbuffered channels.
801 /** Center frequency.
802 * The input signal is downmixed by this frequency before the ADC
803 * anti-aliasing filter.
805 SR_CONF_CENTER_FREQUENCY,
807 /** The device supports setting the number of logic probes. */
808 SR_CONF_NUM_LOGIC_PROBES,
810 /** The device supports setting the number of analog probes. */
811 SR_CONF_NUM_ANALOG_PROBES,
813 /** Output voltage. */
814 SR_CONF_OUTPUT_VOLTAGE,
816 /** Maximum output voltage. */
817 SR_CONF_OUTPUT_VOLTAGE_MAX,
819 /** Output current. */
820 SR_CONF_OUTPUT_CURRENT,
822 /** Maximum output current. */
823 SR_CONF_OUTPUT_CURRENT_MAX,
825 /** Enabling/disabling output. */
826 SR_CONF_OUTPUT_ENABLED,
828 /** Channel output configuration. */
829 SR_CONF_OUTPUT_CHANNEL,
831 /** Over-voltage protection (OVP) */
832 SR_CONF_OVER_VOLTAGE_PROTECTION,
834 /** Over-current protection (OCP) */
835 SR_CONF_OVER_CURRENT_PROTECTION,
837 /*--- Special stuff -------------------------------------------------*/
839 /** Scan options supported by the driver. */
840 SR_CONF_SCAN_OPTIONS = 40000,
842 /** Device options for a particular device. */
843 SR_CONF_DEVICE_OPTIONS,
845 /** Session filename. */
848 /** The device supports specifying a capturefile to inject. */
851 /** The device supports specifying the capturefile unit size. */
852 SR_CONF_CAPTURE_UNITSIZE,
854 /** Power off the device. */
858 * Data source for acquisition. If not present, acquisition from
859 * the device is always "live", i.e. acquisition starts when the
860 * frontend asks and the results are sent out as soon as possible.
862 * If present, it indicates that either the device has no live
863 * acquisition capability (for example a pure data logger), or
864 * there is a choice. sr_config_list() returns those choices.
866 * In any case if a device has live acquisition capabilities, it
867 * is always the default.
871 /*--- Acquisition modes ---------------------------------------------*/
874 * The device supports setting a sample time limit (how long
875 * the sample acquisition should run, in ms).
877 SR_CONF_LIMIT_MSEC = 50000,
880 * The device supports setting a sample number limit (how many
881 * samples should be acquired).
883 SR_CONF_LIMIT_SAMPLES,
886 * The device supports setting a frame limit (how many
887 * frames should be acquired).
889 SR_CONF_LIMIT_FRAMES,
892 * The device supports continuous sampling. Neither a time limit
893 * nor a sample number limit has to be supplied, it will just acquire
894 * samples continuously, until explicitly stopped by a certain command.
898 /** The device has internal storage, into which data is logged. This
899 * starts or stops the internal logging. */
903 /** Device instance data
906 /** Device driver. */
907 struct sr_dev_driver *driver;
908 /** Index of device in driver. */
910 /** Device instance status. SR_ST_NOT_FOUND, etc. */
912 /** Device instance type. SR_INST_USB, etc. */
914 /** Device vendor. */
918 /** Device version. */
920 /** List of probes. */
922 /** List of sr_probe_group structs */
923 GSList *probe_groups;
924 /** Device instance connection data (used?) */
926 /** Device instance private data (used?) */
930 /** Types of device instance, struct sr_dev_inst.type */
932 /** Device instance type for USB devices. */
934 /** Device instance type for serial port devices. */
936 /** Device instance type for SCPI devices. */
940 /** Device instance status, struct sr_dev_inst.status */
942 /** The device instance was not found. */
943 SR_ST_NOT_FOUND = 10000,
944 /** The device instance was found, but is still booting. */
946 /** The device instance is live, but not in use. */
948 /** The device instance is actively in use in a session. */
950 /** The device is winding down its session. */
954 /** Device driver data */
955 struct sr_dev_driver {
956 /* Driver-specific */
959 /** Long name, e.g. device name. */
961 /** API version (currently 1). */
964 int (*init) (struct sr_context *sr_ctx);
966 int (*cleanup) (void);
967 /** Scan for devices */
968 GSList *(*scan) (GSList *options);
969 /** Get device list */
970 GSList *(*dev_list) (void);
971 int (*dev_clear) (void);
972 int (*config_get) (int id, GVariant **data,
973 const struct sr_dev_inst *sdi,
974 const struct sr_probe_group *probe_group);
975 int (*config_set) (int id, GVariant *data,
976 const struct sr_dev_inst *sdi,
977 const struct sr_probe_group *probe_group);
978 int (*config_probe_set) (const struct sr_dev_inst *sdi,
979 struct sr_probe *probe, unsigned int changes);
980 int (*config_commit) (const struct sr_dev_inst *sdi);
981 int (*config_list) (int info_id, GVariant **data,
982 const struct sr_dev_inst *sdi,
983 const struct sr_probe_group *probe_group);
985 /* Device-specific */
987 int (*dev_open) (struct sr_dev_inst *sdi);
989 int (*dev_close) (struct sr_dev_inst *sdi);
990 /** Start data aquisition. */
991 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
993 /** Stop data aquisition. */
994 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
998 /** Device driver private data */
1003 * @struct sr_session
1005 * Opaque data structure representing a libsigrok session. None of the fields
1006 * of this structure are meant to be accessed directly.
1011 #include "version.h"