libsigrok.h

Go to the documentation of this file.

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIBSIGROK_LIBSIGROK_H
#define LIBSIGROK_LIBSIGROK_H

#include <stdio.h>
#include <sys/time.h>
#include <stdint.h>
#include <inttypes.h>
#include <glib.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @file
 *
 * The public libsigrok header file to be used by frontends.
 *
 * This is the only file that libsigrok users (frontends) are supposed to
 * use and \#include. There are other header files which get installed with
 * libsigrok, but those are not meant to be used directly by frontends.
 *
 * The correct way to get/use the libsigrok API functions is:
 *
 * @code{.c}
 *   #include <libsigrok/libsigrok.h>
 * @endcode
 */

/*
 * All possible return codes of libsigrok functions must be listed here.
 * Functions should never return hardcoded numbers as status, but rather
 * use these enum values. All error codes are negative numbers.
 *
 * The error codes are globally unique in libsigrok, i.e. if one of the
 * libsigrok functions returns a "malloc error" it must be exactly the same
 * return value as used by all other functions to indicate "malloc error".
 * There must be no functions which indicate two different errors via the
 * same return code.
 *
 * Also, for compatibility reasons, no defined return codes are ever removed
 * or reused for different errors later. You can only add new entries and
 * return codes, but never remove or redefine existing ones.
 */

/** Status/error codes returned by libsigrok functions. */
enum sr_error_code {
        SR_OK                =  0, /**< No error. */
        SR_ERR               = -1, /**< Generic/unspecified error. */
        SR_ERR_MALLOC        = -2, /**< Malloc/calloc/realloc error. */
        SR_ERR_ARG           = -3, /**< Function argument error. */
        SR_ERR_BUG           = -4, /**< Errors hinting at internal bugs. */
        SR_ERR_SAMPLERATE    = -5, /**< Incorrect samplerate. */
        SR_ERR_NA            = -6, /**< Not applicable. */
        SR_ERR_DEV_CLOSED    = -7, /**< Device is closed, but must be open. */
        SR_ERR_TIMEOUT       = -8, /**< A timeout occurred. */
        SR_ERR_CHANNEL_GROUP = -9, /**< A channel group must be specified. */

        /*
         * Note: When adding entries here, don't forget to also update the
         * sr_strerror() and sr_strerror_name() functions in error.c.
         */
};

#define SR_MAX_CHANNELNAME_LEN 32

/* Handy little macros */
#define SR_HZ(n)  (n)
#define SR_KHZ(n) ((n) * (uint64_t)(1000ULL))
#define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL))
#define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL))

#define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))

/** libsigrok loglevels. */
enum sr_loglevel {
        SR_LOG_NONE = 0, /**< Output no messages at all. */
        SR_LOG_ERR  = 1, /**< Output error messages. */
        SR_LOG_WARN = 2, /**< Output warnings. */
        SR_LOG_INFO = 3, /**< Output informational messages. */
        SR_LOG_DBG  = 4, /**< Output debug messages. */
        SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
};

/*
 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
 *
 * Variables and functions marked 'static' are private already and don't
 * need SR_PRIV. However, functions which are not static (because they need
 * to be used in other libsigrok-internal files) but are also not meant to
 * be part of the public libsigrok API, must use SR_PRIV.
 *
 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
 *
 * This feature is not available on MinGW/Windows, as it is a feature of
 * ELF files and MinGW/Windows uses PE files.
 *
 * Details: http://gcc.gnu.org/wiki/Visibility
 */

/* Marks public libsigrok API symbols. */
#ifndef _WIN32
#define SR_API __attribute__((visibility("default")))
#else
#define SR_API
#endif

/* Marks private, non-public libsigrok symbols (not part of the API). */
#ifndef _WIN32
#define SR_PRIV __attribute__((visibility("hidden")))
#else
#define SR_PRIV
#endif

/** Type definition for callback function for data reception. */
typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data);

/** Data types used by sr_config_info(). */
enum sr_datatype {
        SR_T_UINT64 = 10000,
        SR_T_STRING,
        SR_T_BOOL,
        SR_T_FLOAT,
        SR_T_RATIONAL_PERIOD,
        SR_T_RATIONAL_VOLT,
        SR_T_KEYVALUE,
        SR_T_UINT64_RANGE,
        SR_T_DOUBLE_RANGE,
        SR_T_INT32,
};

/** Value for sr_datafeed_packet.type. */
enum sr_packettype {
        /** Payload is sr_datafeed_header. */
        SR_DF_HEADER = 10000,
        /** End of stream (no further data). */
        SR_DF_END,
        /** Payload is struct sr_datafeed_meta */
        SR_DF_META,
        /** The trigger matched at this point in the data feed. No payload. */
        SR_DF_TRIGGER,
        /** Payload is struct sr_datafeed_logic. */
        SR_DF_LOGIC,
        /** Payload is struct sr_datafeed_analog. */
        SR_DF_ANALOG,
        /** Beginning of frame. No payload. */
        SR_DF_FRAME_BEGIN,
        /** End of frame. No payload. */
        SR_DF_FRAME_END,
};

/** Measured quantity, sr_datafeed_analog.mq. */
enum sr_mq {
        SR_MQ_VOLTAGE = 10000,
        SR_MQ_CURRENT,
        SR_MQ_RESISTANCE,
        SR_MQ_CAPACITANCE,
        SR_MQ_TEMPERATURE,
        SR_MQ_FREQUENCY,
        /** Duty cycle, e.g. on/off ratio. */
        SR_MQ_DUTY_CYCLE,
        /** Continuity test. */
        SR_MQ_CONTINUITY,
        SR_MQ_PULSE_WIDTH,
        SR_MQ_CONDUCTANCE,
        /** Electrical power, usually in W, or dBm. */
        SR_MQ_POWER,
        /** Gain (a transistor's gain, or hFE, for example). */
        SR_MQ_GAIN,
        /** Logarithmic representation of sound pressure relative to a
         * reference value. */
        SR_MQ_SOUND_PRESSURE_LEVEL,
        /** Carbon monoxide level */
        SR_MQ_CARBON_MONOXIDE,
        /** Humidity */
        SR_MQ_RELATIVE_HUMIDITY,
        /** Time */
        SR_MQ_TIME,
};

/** Unit of measured quantity, sr_datafeed_analog.unit. */
enum sr_unit {
        /** Volt */
        SR_UNIT_VOLT = 10000,
        /** Ampere (current). */
        SR_UNIT_AMPERE,
        /** Ohm (resistance). */
        SR_UNIT_OHM,
        /** Farad (capacity). */
        SR_UNIT_FARAD,
        /** Kelvin (temperature). */
        SR_UNIT_KELVIN,
        /** Degrees Celsius (temperature). */
        SR_UNIT_CELSIUS,
        /** Degrees Fahrenheit (temperature). */
        SR_UNIT_FAHRENHEIT,
        /** Hertz (frequency, 1/s, [Hz]). */
        SR_UNIT_HERTZ,
        /** Percent value. */
        SR_UNIT_PERCENTAGE,
        /** Boolean value. */
        SR_UNIT_BOOLEAN,
        /** Time in seconds. */
        SR_UNIT_SECOND,
        /** Unit of conductance, the inverse of resistance. */
        SR_UNIT_SIEMENS,
        /**
         * An absolute measurement of power, in decibels, referenced to
         * 1 milliwatt (dBu).
         */
        SR_UNIT_DECIBEL_MW,
        /** Voltage in decibel, referenced to 1 volt (dBV). */
        SR_UNIT_DECIBEL_VOLT,
        /**
         * Measurements that intrinsically do not have units attached, such
         * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
         * a unitless quantity, for example.
         */
        SR_UNIT_UNITLESS,
        /** Sound pressure level relative so 20 micropascals. */
        SR_UNIT_DECIBEL_SPL,
        /**
         * Normalized (0 to 1) concentration of a substance or compound with 0
         * representing a concentration of 0%, and 1 being 100%. This is
         * represented as the fraction of number of particles of the substance.
         */
        SR_UNIT_CONCENTRATION,
        /** Revolutions per minute. */
        SR_UNIT_REVOLUTIONS_PER_MINUTE,
        /** Apparent power [VA]. */
        SR_UNIT_VOLT_AMPERE,
        /** Real power [W]. */
        SR_UNIT_WATT,
        /** Consumption [Wh]. */
        SR_UNIT_WATT_HOUR,
};

/** Values for sr_datafeed_analog.flags. */
enum sr_mqflag {
        /** Voltage measurement is alternating current (AC). */
        SR_MQFLAG_AC = 0x01,
        /** Voltage measurement is direct current (DC). */
        SR_MQFLAG_DC = 0x02,
        /** This is a true RMS measurement. */
        SR_MQFLAG_RMS = 0x04,
        /** Value is voltage drop across a diode, or NAN. */
        SR_MQFLAG_DIODE = 0x08,
        /** Device is in "hold" mode (repeating the last measurement). */
        SR_MQFLAG_HOLD = 0x10,
        /** Device is in "max" mode, only updating upon a new max value. */
        SR_MQFLAG_MAX = 0x20,
        /** Device is in "min" mode, only updating upon a new min value. */
        SR_MQFLAG_MIN = 0x40,
        /** Device is in autoranging mode. */
        SR_MQFLAG_AUTORANGE = 0x80,
        /** Device is in relative mode. */
        SR_MQFLAG_RELATIVE = 0x100,
        /** Sound pressure level is A-weighted in the frequency domain,
         * according to IEC 61672:2003. */
        SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
        /** Sound pressure level is C-weighted in the frequency domain,
         * according to IEC 61672:2003. */
        SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
        /** Sound pressure level is Z-weighted (i.e. not at all) in the
         * frequency domain, according to IEC 61672:2003. */
        SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
        /** Sound pressure level is not weighted in the frequency domain,
         * albeit without standards-defined low and high frequency limits. */
        SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
        /** Sound pressure level measurement is S-weighted (1s) in the
         * time domain. */
        SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
        /** Sound pressure level measurement is F-weighted (125ms) in the
         * time domain. */
        SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
        /** Sound pressure level is time-averaged (LAT), also known as
         * Equivalent Continuous A-weighted Sound Level (LEQ). */
        SR_MQFLAG_SPL_LAT = 0x8000,
        /** Sound pressure level represented as a percentage of measurements
         * that were over a preset alarm level. */
        SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
        /** Time is duration (as opposed to epoch, ...). */
        SR_MQFLAG_DURATION = 0x20000,
        /** Device is in "avg" mode, averaging upon each new value. */
        SR_MQFLAG_AVG = 0x40000,
};

/**
 * @struct sr_context
 * Opaque structure representing a libsigrok context.
 *
 * None of the fields of this structure are meant to be accessed directly.
 *
 * @see sr_init(), sr_exit().
 */
struct sr_context;

/** Packet in a sigrok data feed. */
struct sr_datafeed_packet {
        uint16_t type;
        const void *payload;
};

/** Header of a sigrok data feed. */
struct sr_datafeed_header {
        int feed_version;
        struct timeval starttime;
};

/** Datafeed payload for type SR_DF_META. */
struct sr_datafeed_meta {
        GSList *config;
};

/** Logic datafeed payload for type SR_DF_LOGIC. */
struct sr_datafeed_logic {
        uint64_t length;
        uint16_t unitsize;
        void *data;
};

/** Analog datafeed payload for type SR_DF_ANALOG. */
struct sr_datafeed_analog {
        /** The channels for which data is included in this packet. */
        GSList *channels;
        /** Number of samples in data */
        int num_samples;
        /** Measured quantity (voltage, current, temperature, and so on).
         *  Use SR_MQ_VOLTAGE, ... */
        int mq;
        /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
        int unit;
        /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
        uint64_t mqflags;
        /** The analog value(s). The data is interleaved according to
         * the channels list. */
        float *data;
};

/** Input (file) format struct. */
struct sr_input {
        /**
         * A pointer to this input format's 'struct sr_input_format'.
         * The frontend can use this to call the module's callbacks.
         */
        struct sr_input_format *format;

        GHashTable *param;

        struct sr_dev_inst *sdi;

        void *internal;
};

/** Input (file) format driver. */
struct sr_input_format {
        /** The unique ID for this input format. Must not be NULL. */
        char *id;

        /**
         * A short description of the input format, which can (for example)
         * be displayed to the user by frontends. Must not be NULL.
         */
        char *description;

        /**
         * Check if this input module can load and parse the specified file.
         *
         * @param[in] filename The name (and path) of the file to check.
         *
         * @retval TRUE This module knows the format.
         * @retval FALSE This module does not know the format.
         */
        int (*format_match) (const char *filename);

        /**
         * Initialize the input module.
         *
         * @param in A pointer to a valid 'struct sr_input' that the caller
         *           has to allocate and provide to this function. It is also
         *           the responsibility of the caller to free it later.
         * @param[in] filename The name (and path) of the file to use.
         *
         * @retval SR_OK Success
         * @retval other Negative error code.
         */
        int (*init) (struct sr_input *in, const char *filename);

        /**
         * Load a file, parsing the input according to the file's format.
         *
         * This function will send datafeed packets to the session bus, so
         * the calling frontend must have registered its session callbacks
         * beforehand.
         *
         * The packet types sent across the session bus by this function must
         * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
         * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
         * if appropriate.
         *
         * @param in A pointer to a valid 'struct sr_input' that the caller
         *           has to allocate and provide to this function. It is also
         *           the responsibility of the caller to free it later.
         * @param filename The name (and path) of the file to use.
         *
         * @retval SR_OK Success
         * @retval other Negative error code.
         */
        int (*loadfile) (struct sr_input *in, const char *filename);
};

/** Output (file) format struct. */
struct sr_output {
        /** A pointer to this output's format.  */
        struct sr_output_format *format;

        /**
         * The device for which this output module is creating output. This
         * can be used by the module to find out channel names and numbers.
         */
        const struct sr_dev_inst *sdi;

        /**
         * An optional parameter which the frontend can pass in to the
         * output module. How the string is interpreted is entirely up to
         * the module.
         */
        GHashTable *params;

        /**
         * A generic pointer which can be used by the module to keep internal
         * state between calls into its callback functions.
         *
         * For example, the module might store a pointer to a chunk of output
         * there, and only flush it when it reaches a certain size.
         */
        void *internal;
};

/** Output (file) format driver. */
struct sr_output_format {
        /**
         * A unique ID for this output format. Must not be NULL.
         *
         * It can be used by frontends to select this output format for use.
         *
         * For example, calling sigrok-cli with <code>-O hex</code> will
         * select the hexadecimal text output format.
         */
        char *id;

        /**
         * A short description of the output format. Must not be NULL.
         *
         * This can be displayed by frontends, e.g. when selecting the output
         * format for saving a file.
         */
        char *description;

        /**
         * This function is called once, at the beginning of an output stream.
         *
         * The device struct will be available in the output struct passed in,
         * as well as the param field -- which may be NULL or an empty string,
         * if no parameter was passed.
         *
         * The module can use this to initialize itself, create a struct for
         * keeping state and storing it in the <code>internal</code> field.
         *
         * @param o Pointer to the respective 'struct sr_output'.
         *
         * @retval SR_OK Success
         * @retval other Negative error code.
         */
        int (*init) (struct sr_output *o);

        /**
         * This function is passed a copy of every packed in the data feed.
         * Any output generated by the output module in response to the
         * packet should be returned in a newly allocated GString
         * <code>out</code>, which will be freed by the caller.
         *
         * Packets not of interest to the output module can just be ignored,
         * and the <code>out</code> parameter set to NULL.
         *
         * @param o Pointer to the respective 'struct sr_output'.
         * @param sdi The device instance that generated the packet.
         * @param packet The complete packet.
         * @param out A pointer where a GString * should be stored if
         * the module generates output, or NULL if not.
         *
         * @retval SR_OK Success
         * @retval other Negative error code.
         */
        int (*receive) (struct sr_output *o,
                        const struct sr_datafeed_packet *packet, GString **out);

        /**
         * This function is called after the caller is finished using
         * the output module, and can be used to free any internal
         * resources the module may keep.
         *
         * @retval SR_OK Success
         * @retval other Negative error code.
         */
        int (*cleanup) (struct sr_output *o);
};

/** Constants for channel type. */
enum sr_channeltype {
        /** Channel type is logic channel. */
        SR_CHANNEL_LOGIC = 10000,
        /** Channel type is analog channel. */
        SR_CHANNEL_ANALOG,
};

/** Information on single channel. */
struct sr_channel {
        /** Number of channels, starting at 0. */
        int index;
        /** Channel type (SR_CHANNEL_LOGIC, ...) */
        int type;
        /** Is this channel enabled? */
        gboolean enabled;
        /** Name of channel. */
        char *name;
        /** Trigger string, format like used by sigrok-cli */
        char *trigger;
};

/** Structure for groups of channels that have common properties. */
struct sr_channel_group {
        /** Name of the channel group. */
        char *name;
        /** List of sr_channel structs of the channels belonging to this group. */
        GSList *channels;
        /** Private data for driver use. */
        void *priv;
};

/** Used for setting or getting value of a config item. */
struct sr_config {
        /** Config key like SR_CONF_CONN, etc. */
        int key;
        /** Key-specific data. */
        GVariant *data;
};

/** Information about a config key. */
struct sr_config_info {
        /** Config key like SR_CONF_CONN, etc. */
        int key;
        /** Data type like SR_T_STRING, etc. */
        int datatype;
        /** Id string, e.g. "serialcomm". */
        char *id;
        /** Name, e.g. "Serial communication". */
        char *name;
        /** Verbose description (unused currently). */
        char *description;
};

/** Constants for device classes */
enum sr_configkey {
        /*--- Device classes ------------------------------------------------*/

        /** The device can act as logic analyzer. */
        SR_CONF_LOGIC_ANALYZER = 10000,

        /** The device can act as an oscilloscope. */
        SR_CONF_OSCILLOSCOPE,

        /** The device can act as a multimeter. */
        SR_CONF_MULTIMETER,

        /** The device is a demo device. */
        SR_CONF_DEMO_DEV,

        /** The device can act as a sound level meter. */
        SR_CONF_SOUNDLEVELMETER,

        /** The device can measure temperature. */
        SR_CONF_THERMOMETER,

        /** The device can measure humidity. */
        SR_CONF_HYGROMETER,

        /** The device can measure energy consumption. */
        SR_CONF_ENERGYMETER,

        /** The device can demodulate signals. */
        SR_CONF_DEMODULATOR,

        /** Programmable power supply. */
        SR_CONF_POWER_SUPPLY,

        /*--- Driver scan options -------------------------------------------*/

        /**
         * Specification on how to connect to a device.
         *
         * In combination with SR_CONF_SERIALCOMM, this is a serial port in
         * the form which makes sense to the OS (e.g., /dev/ttyS0).
         * Otherwise this specifies a USB device, either in the form of
         * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
         * @verbatim <vendorid>.<productid> @endverbatim
         * (hexadecimal, e.g. 1d6b.0001).
         */
        SR_CONF_CONN = 20000,

        /**
         * Serial communication specification, in the form:
         *
         *   @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
         *
         * Example: 9600/8n1
         *
         * The string may also be followed by one or more special settings,
         * in the form "/key=value". Supported keys and their values are:
         *
         * rts    0,1    set the port's RTS pin to low or high
         * dtr    0,1    set the port's DTR pin to low or high
         * flow   0      no flow control
         *        1      hardware-based (RTS/CTS) flow control
         *        2      software-based (XON/XOFF) flow control
         *
         * This is always an optional parameter, since a driver typically
         * knows the speed at which the device wants to communicate.
         */
        SR_CONF_SERIALCOMM,

        /*--- Device configuration ------------------------------------------*/

        /** The device supports setting its samplerate, in Hz. */
        SR_CONF_SAMPLERATE = 30000,

        /** The device supports setting a pre/post-trigger capture ratio. */
        SR_CONF_CAPTURE_RATIO,

        /** The device supports setting a pattern (pattern generator mode). */
        SR_CONF_PATTERN_MODE,

        /** The device supports Run Length Encoding. */
        SR_CONF_RLE,

        /** The device supports setting trigger slope. */
        SR_CONF_TRIGGER_SLOPE,

        /** Trigger source. */
        SR_CONF_TRIGGER_SOURCE,

        /** Horizontal trigger position. */
        SR_CONF_HORIZ_TRIGGERPOS,

        /** Buffer size. */
        SR_CONF_BUFFERSIZE,

        /** Time base. */
        SR_CONF_TIMEBASE,

        /** Filter. */
        SR_CONF_FILTER,

        /** Volts/div. */
        SR_CONF_VDIV,

        /** Coupling. */
        SR_CONF_COUPLING,

        /** Trigger types.  */
        SR_CONF_TRIGGER_TYPE,

        /** The device supports setting its sample interval, in ms. */
        SR_CONF_SAMPLE_INTERVAL,

        /** Number of timebases, as related to SR_CONF_TIMEBASE.  */
        SR_CONF_NUM_TIMEBASE,

        /** Number of vertical divisions, as related to SR_CONF_VDIV.  */
        SR_CONF_NUM_VDIV,

        /** Sound pressure level frequency weighting.  */
        SR_CONF_SPL_WEIGHT_FREQ,

        /** Sound pressure level time weighting.  */
        SR_CONF_SPL_WEIGHT_TIME,

        /** Sound pressure level measurement range.  */
        SR_CONF_SPL_MEASUREMENT_RANGE,

        /** Max hold mode. */
        SR_CONF_HOLD_MAX,

        /** Min hold mode. */
        SR_CONF_HOLD_MIN,

        /** Logic low-high threshold range. */
        SR_CONF_VOLTAGE_THRESHOLD,

        /** The device supports using an external clock. */
        SR_CONF_EXTERNAL_CLOCK,

        /**
         * The device supports swapping channels. Typical this is between
         * buffered and unbuffered channels.
         */
        SR_CONF_SWAP,

        /** Center frequency.
         * The input signal is downmixed by this frequency before the ADC
         * anti-aliasing filter.
         */
        SR_CONF_CENTER_FREQUENCY,

        /** The device supports setting the number of logic channels. */
        SR_CONF_NUM_LOGIC_CHANNELS,

        /** The device supports setting the number of analog channels. */
        SR_CONF_NUM_ANALOG_CHANNELS,

        /** Output voltage. */
        SR_CONF_OUTPUT_VOLTAGE,

        /** Maximum output voltage. */
        SR_CONF_OUTPUT_VOLTAGE_MAX,

        /** Output current. */
        SR_CONF_OUTPUT_CURRENT,

        /** Maximum output current. */
        SR_CONF_OUTPUT_CURRENT_MAX,

        /** Enabling/disabling output. */
        SR_CONF_OUTPUT_ENABLED,

        /** Channel output configuration. */
        SR_CONF_OUTPUT_CHANNEL,

        /** Over-voltage protection (OVP) */
        SR_CONF_OVER_VOLTAGE_PROTECTION,

        /** Over-current protection (OCP) */
        SR_CONF_OVER_CURRENT_PROTECTION,

        /** Choice of clock edge for external clock ("r" or "f"). */
        SR_CONF_CLOCK_EDGE,

        /*--- Special stuff -------------------------------------------------*/

        /** Scan options supported by the driver. */
        SR_CONF_SCAN_OPTIONS = 40000,

        /** Device options for a particular device. */
        SR_CONF_DEVICE_OPTIONS,

        /** Session filename. */
        SR_CONF_SESSIONFILE,

        /** The device supports specifying a capturefile to inject. */
        SR_CONF_CAPTUREFILE,

        /** The device supports specifying the capturefile unit size. */
        SR_CONF_CAPTURE_UNITSIZE,

        /** Power off the device. */
        SR_CONF_POWER_OFF,

        /**
         * Data source for acquisition. If not present, acquisition from
         * the device is always "live", i.e. acquisition starts when the
         * frontend asks and the results are sent out as soon as possible.
         *
         * If present, it indicates that either the device has no live
         * acquisition capability (for example a pure data logger), or
         * there is a choice. sr_config_list() returns those choices.
         *
         * In any case if a device has live acquisition capabilities, it
         * is always the default.
         */
        SR_CONF_DATA_SOURCE,

        /*--- Acquisition modes ---------------------------------------------*/

        /**
         * The device supports setting a sample time limit (how long
         * the sample acquisition should run, in ms).
         */
        SR_CONF_LIMIT_MSEC = 50000,

        /**
         * The device supports setting a sample number limit (how many
         * samples should be acquired).
         */
        SR_CONF_LIMIT_SAMPLES,

        /**
         * The device supports setting a frame limit (how many
         * frames should be acquired).
         */
        SR_CONF_LIMIT_FRAMES,

        /**
         * The device supports continuous sampling. Neither a time limit
         * nor a sample number limit has to be supplied, it will just acquire
         * samples continuously, until explicitly stopped by a certain command.
         */
        SR_CONF_CONTINUOUS,

        /** The device has internal storage, into which data is logged. This
         * starts or stops the internal logging. */
        SR_CONF_DATALOG,

        /** Device mode for multi-function devices. */
        SR_CONF_DEVICE_MODE,

        /** Self test mode. */
        SR_CONF_TEST_MODE,
};

/** Device instance data
 */
struct sr_dev_inst {
        /** Device driver. */
        struct sr_dev_driver *driver;
        /** Index of device in driver. */
        int index;
        /** Device instance status. SR_ST_NOT_FOUND, etc. */
        int status;
        /** Device instance type. SR_INST_USB, etc. */
        int inst_type;
        /** Device vendor. */
        char *vendor;
        /** Device model. */
        char *model;
        /** Device version. */
        char *version;
        /** List of channels. */
        GSList *channels;
        /** List of sr_channel_group structs */
        GSList *channel_groups;
        /** Device instance connection data (used?) */
        void *conn;
        /** Device instance private data (used?) */
        void *priv;
};

/** Types of device instance, struct sr_dev_inst.type */
enum sr_dev_inst_type {
        /** Device instance type for USB devices. */
        SR_INST_USB = 10000,
        /** Device instance type for serial port devices. */
        SR_INST_SERIAL,
        /** Device instance type for SCPI devices. */
        SR_INST_SCPI,
};

/** Device instance status, struct sr_dev_inst.status */
enum sr_dev_inst_status {
        /** The device instance was not found. */
        SR_ST_NOT_FOUND = 10000,
        /** The device instance was found, but is still booting. */
        SR_ST_INITIALIZING,
        /** The device instance is live, but not in use. */
        SR_ST_INACTIVE,
        /** The device instance is actively in use in a session. */
        SR_ST_ACTIVE,
        /** The device is winding down its session. */
        SR_ST_STOPPING,
};

/** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
struct sr_dev_driver {
        /* Driver-specific */
        /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
        char *name;
        /** Long name. Verbose driver name shown to user. */
        char *longname;
        /** API version (currently 1).  */
        int api_version;
        /** Called when driver is loaded, e.g. program startup. */
        int (*init) (struct sr_context *sr_ctx);
        /** Called before driver is unloaded.
         *  Driver must free all resouces held by it. */
        int (*cleanup) (void);
        /** Scan for devices. Driver should do all initialisation required.
         *  Can be called several times, e.g. with different port options.
         *  \retval NULL Error or no devices found.
         *  \retval other GSList of a struct sr_dev_inst for each device.
         *                Must be freed by caller!
         */
        GSList *(*scan) (GSList *options);
        /** Get list of device instances the driver knows about.
         *  \returns NULL or GSList of a struct sr_dev_inst for each device.
         *           Must not be freed by caller!
         */
        GSList *(*dev_list) (void);
        /** Clear list of devices the driver knows about. */
        int (*dev_clear) (void);
        /** Query value of a configuration key in driver or given device instance.
         *  @see sr_config_get().
         */
        int (*config_get) (int id, GVariant **data,
                        const struct sr_dev_inst *sdi,
                        const struct sr_channel_group *cg);
        /** Set value of a configuration key in driver or a given device instance.
         *  @see sr_config_set(). */
        int (*config_set) (int id, GVariant *data,
                        const struct sr_dev_inst *sdi,
                        const struct sr_channel_group *cg);
        /** Channel status change.
         *  @see sr_dev_channel_enable(), sr_dev_trigger_set(). */
        int (*config_channel_set) (const struct sr_dev_inst *sdi,
                        struct sr_channel *ch, unsigned int changes);
        /** Apply configuration settings to the device hardware.
         *  @see sr_config_commit().*/
        int (*config_commit) (const struct sr_dev_inst *sdi);
        /** List all possible values for a configuration key in a device instance.
         *  @see sr_config_list().
         */
        int (*config_list) (int info_id, GVariant **data,
                        const struct sr_dev_inst *sdi,
                        const struct sr_channel_group *cg);

        /* Device-specific */
        /** Open device */
        int (*dev_open) (struct sr_dev_inst *sdi);
        /** Close device */
        int (*dev_close) (struct sr_dev_inst *sdi);
        /** Begin data acquisition on the specified device. */
        int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
                        void *cb_data);
        /** End data acquisition on the specified device. */
        int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
                        void *cb_data);

        /* Dynamic */
        /** Device driver private data. Initialized by init(). */
        void *priv;
};

/**
 * @struct sr_session
 *
 * Opaque data structure representing a libsigrok session. None of the fields
 * of this structure are meant to be accessed directly.
 */
struct sr_session;

#include "proto.h"
#include "version.h"

#ifdef __cplusplus
}
#endif

#endif