sr_driver_list() now takes a context pointer.

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

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 7f10d0e2593a5f9879b045fe9038f111eb51dd9c..7b4ca15bbe1410abdd06267819a539a5c8d9315c 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
@@ -223,6 +224,12 @@ enum sr_mq {
        SR_MQ_PHASE_ANGLE,
        /** Difference from reference value. */
        SR_MQ_DIFFERENCE,
+       /** Count. */
+       SR_MQ_COUNT,
+       /** Power factor. */
+       SR_MQ_POWER_FACTOR,
+       /** Apparent power */
+       SR_MQ_APPARENT_POWER,
 };
 
 /** Unit of measured quantity, sr_datafeed_analog.unit. */
@@ -284,7 +291,7 @@ enum sr_unit {
        SR_UNIT_METER_SECOND,
        /** Pressure in hectopascal */
        SR_UNIT_HECTOPASCAL,
-       /** Relative humidity assuming air temperature of 293 kelvin (%rF). */
+       /** Relative humidity assuming air temperature of 293 Kelvin (%rF). */
        SR_UNIT_HUMIDITY_293K,
        /** Plane angle in 1/360th of a full circle. */
        SR_UNIT_DEGREE,
@@ -515,6 +522,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 {
@@ -526,6 +535,8 @@ enum sr_channeltype {
 
 /** Information on single channel. */
 struct sr_channel {
+       /** The device this channel is attached to. */
+       struct sr_dev_inst *sdi;
        /** The index of this channel, starting at 0. Logic channels will
         * be encoded according to this index in SR_DF_LOGIC packets. */
        int index;
@@ -576,7 +587,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 +615,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 +659,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 +670,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,
 
@@ -692,8 +712,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,
@@ -894,7 +914,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
@@ -975,24 +998,24 @@ struct sr_dev_driver {
        /** API version (currently 1).  */
        int api_version;
        /** Called when driver is loaded, e.g. program startup. */
-       int (*init) (struct sr_context *sr_ctx);
+       int (*init) (struct sr_dev_driver *driver, struct sr_context *sr_ctx);
        /** Called before driver is unloaded.
         *  Driver must free all resources held by it. */
-       int (*cleanup) (void);
+       int (*cleanup) (const struct sr_dev_driver *driver);
        /** 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);
+       GSList *(*scan) (struct sr_dev_driver *driver, 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);
+       GSList *(*dev_list) (const struct sr_dev_driver *driver);
        /** Clear list of devices the driver knows about. */
-       int (*dev_clear) (void);
+       int (*dev_clear) (const struct sr_dev_driver *driver);
        /** Query value of a configuration key in driver or given device instance.
         *  @see sr_config_get().
         */
@@ -1043,6 +1066,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"