SR_ERR_IO: new error code

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

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 7f10d0e2593a5f9879b045fe9038f111eb51dd9c..353860d9e529871e62b712fefebc47205fb7ac14 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
@@ -515,6 +516,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 {
@@ -576,7 +579,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 ------------------------------------------------*/
 
@@ -604,13 +607,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 -------------------------------------------*/
@@ -648,7 +651,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,
@@ -659,12 +662,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,
 
@@ -894,7 +906,7 @@ enum sr_configkey {
         */
        SR_CONF_DATA_SOURCE,
 
-       /*--- Acquisition modes ---------------------------------------------*/
+       /*--- Acquisition modes, sample limiting ----------------------------*/
 
        /**
         * The device supports setting a sample time limit (how long
@@ -1043,6 +1055,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"