Rename SR_CONF_NUM_TIMEBASE to SR_CONF_NUM_HDIV.

[libsigrok.git] / include / libsigrok / libsigrok.h

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 63201bfbf6c08670174935c1324c15b009ebafaa..662e986e56df88995d73a65401823ab588ea4701 100644 (file)
--- a/include/libsigrok/libsigrok.h
+++ b/include/libsigrok/libsigrok.h
@@ -76,6 +76,7 @@ enum sr_error_code {
        SR_ERR_TIMEOUT       = -8, /**< A timeout occurred. */
        SR_ERR_CHANNEL_GROUP = -9, /**< A channel group must be specified. */
        SR_ERR_DATA          =-10, /**< Data is invalid.  */
+       SR_ERR_IO            =-11, /**< Input/output error. */
 
        /*
         * Note: When adding entries here, don't forget to also update the
@@ -168,6 +169,8 @@ enum sr_packettype {
        SR_DF_FRAME_BEGIN,
        /** End of frame. No payload. */
        SR_DF_FRAME_END,
+       /** Payload is struct sr_datafeed_analog2. */
+       SR_DF_ANALOG2,
 };
 
 /** Measured quantity, sr_datafeed_analog.mq. */
@@ -221,6 +224,8 @@ enum sr_mq {
        SR_MQ_PHASE_ANGLE,
        /** Difference from reference value. */
        SR_MQ_DIFFERENCE,
+       /** Count. */
+       SR_MQ_COUNT,
 };
 
 /** Unit of measured quantity, sr_datafeed_analog.unit. */
@@ -415,6 +420,13 @@ struct sr_context;
  */
 struct sr_session;
 
+struct sr_rational {
+       /** Numerator of the rational number. */
+       uint64_t p;
+       /** Denominator of the rational number. */
+       uint64_t q;
+};
+
 /** Packet in a sigrok data feed. */
 struct sr_datafeed_packet {
        uint16_t type;
@@ -457,6 +469,37 @@ struct sr_datafeed_analog {
        float *data;
 };
 
+/** Analog datafeed payload for type SR_DF_ANALOG2. */
+struct sr_datafeed_analog2 {
+       void *data;
+       uint32_t num_samples;
+       struct sr_analog_encoding *encoding;
+       struct sr_analog_meaning *meaning;
+       struct sr_analog_spec *spec;
+};
+
+struct sr_analog_encoding {
+       uint8_t unitsize;
+       gboolean is_signed;
+       gboolean is_float;
+       gboolean is_bigendian;
+       uint8_t digits;
+       gboolean is_digits_decimal;
+       struct sr_rational scale;
+       struct sr_rational offset;
+};
+
+struct sr_analog_meaning {
+       enum sr_mq mq;
+       enum sr_unit unit;
+       enum sr_mqflag mqflags;
+       GSList *channels;
+};
+
+struct sr_analog_spec {
+       uint8_t spec_digits;
+};
+
 /** Generic option struct used by various subsystems. */
 struct sr_option {
        /* Short name suitable for commandline usage, [a-z0-9-]. */
@@ -475,6 +518,8 @@ struct sr_input;
 struct sr_input_module;
 struct sr_output;
 struct sr_output_module;
+struct sr_transform;
+struct sr_transform_module;
 
 /** Constants for channel type. */
 enum sr_channeltype {
@@ -536,7 +581,7 @@ struct sr_config_info {
 #define SR_CONF_LIST (1 << 29)
 #define SR_CONF_MASK 0x1fffffff
 
-/** Constants for device classes */
+/** Configuration keys */
 enum sr_configkey {
        /*--- Device classes ------------------------------------------------*/
 
@@ -564,13 +609,13 @@ enum sr_configkey {
        /** The device can measure energy consumption. */
        SR_CONF_ENERGYMETER,
 
-       /** The device can demodulate signals. */
+       /** The device can act as a signal demodulator. */
        SR_CONF_DEMODULATOR,
 
-       /** Programmable power supply. */
+       /** The device can act as a programmable power supply. */
        SR_CONF_POWER_SUPPLY,
 
-       /** LCR meter. */
+       /** The device can act as an LCR meter. */
        SR_CONF_LCRMETER,
 
        /*--- Driver scan options -------------------------------------------*/
@@ -608,7 +653,7 @@ enum sr_configkey {
         */
        SR_CONF_SERIALCOMM,
 
-       /*--- Device configuration ------------------------------------------*/
+       /*--- Device (or channel group) configuration -----------------------*/
 
        /** The device supports setting its samplerate, in Hz. */
        SR_CONF_SAMPLERATE = 30000,
@@ -619,12 +664,21 @@ enum sr_configkey {
        /** The device supports setting a pattern (pattern generator mode). */
        SR_CONF_PATTERN_MODE,
 
-       /** The device supports Run Length Encoding. */
+       /** The device supports run-length encoding (RLE). */
        SR_CONF_RLE,
 
        /** The device supports setting trigger slope. */
        SR_CONF_TRIGGER_SLOPE,
 
+       /** The device supports averaging. */
+       SR_CONF_AVERAGING,
+
+       /**
+        * The device supports setting number of samples to be
+        * averaged over.
+        */
+       SR_CONF_AVG_SAMPLES,
+
        /** Trigger source. */
        SR_CONF_TRIGGER_SOURCE,
 
@@ -652,8 +706,8 @@ enum sr_configkey {
        /** 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 horizontal divisions, as related to SR_CONF_TIMEBASE. */
+       SR_CONF_NUM_HDIV,
 
        /** Number of vertical divisions, as related to SR_CONF_VDIV.  */
        SR_CONF_NUM_VDIV,
@@ -854,7 +908,10 @@ enum sr_configkey {
         */
        SR_CONF_DATA_SOURCE,
 
-       /*--- Acquisition modes ---------------------------------------------*/
+       /** The device supports setting a probe factor. */
+       SR_CONF_PROBE_FACTOR,
+
+       /*--- Acquisition modes, sample limiting ----------------------------*/
 
        /**
         * The device supports setting a sample time limit (how long
@@ -1003,6 +1060,14 @@ struct sr_dev_driver {
  */
 struct sr_session;
 
+/** Serial port descriptor. */
+struct sr_serial_port {
+       /** The OS dependent name of the serial port. */
+       char *name;
+       /** An end user friendly description for the serial port. */
+       char *description;
+};
+
 #include "proto.h"
 #include "version.h"