doxygen: Fix/improve 'struct sr_probe_group' documentation.

[libsigrok.git] / libsigrok.h

diff --git a/libsigrok.h b/libsigrok.h
index b8f4f757019d45c6be16c957c2e0f83e2e0e4a2d..7f18d6902d596c4917da3b016b48f2a01cb21381 100644 (file)
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -73,6 +73,7 @@ enum {
        SR_ERR_NA         = -6, /**< Not applicable. */
        SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but needs to be open. */
        SR_ERR_TIMEOUT    = -8, /**< A timeout occurred. */
+       SR_ERR_PROBE_GROUP= -9, /**< A probe group must be specified. */
 
        /*
         * Note: When adding entries here, don't forget to also update the
@@ -216,6 +217,10 @@ enum {
         * represented as the fraction of number of particles of the substance.
         */
        SR_UNIT_CONCENTRATION,
+       SR_UNIT_REVOLUTIONS_PER_MINUTE,
+       SR_UNIT_VOLT_AMPERE,
+       SR_UNIT_WATT,
+       SR_UNIT_WATT_HOUR,
 };
 
 /** Values for sr_datafeed_analog.flags. */
@@ -545,6 +550,16 @@ struct sr_probe {
        char *trigger;
 };
 
+/** Structure for groups of probes that have common properties. */
+struct sr_probe_group {
+       /** Name of the probe group. */
+       char *name;
+       /** List of sr_probe structs of the probes belonging to this group. */
+       GSList *probes;
+       /** Private data for driver use. */
+       void *priv;
+};
+
 struct sr_config {
        int key;
        GVariant *data;
@@ -582,6 +597,9 @@ enum {
        /** The device can measure humidity. */
        SR_CONF_HYGROMETER,
 
+       /** The device can measure energy consumption. */
+       SR_CONF_ENERGYMETER,
+
        /*--- Driver scan options -------------------------------------------*/
 
        /**
@@ -628,9 +646,6 @@ enum {
        /** The device supports setting a pattern (pattern generator mode). */
        SR_CONF_PATTERN_MODE,
 
-       /** The devices supports using a external clock. */
-       SR_CONF_EXTERNAL_CLOCK,
-
        /** The device supports Run Length Encoding. */
        SR_CONF_RLE,
 
@@ -688,6 +703,15 @@ enum {
        /** Logic low-high threshold range. */
        SR_CONF_VOLTAGE_THRESHOLD,
 
+       /** The device supports using a external clock. */
+       SR_CONF_EXTERNAL_CLOCK,
+
+       /**
+        * The device supports swapping channels. Typical this is between
+        * buffered and unbuffered channels.
+        */
+       SR_CONF_SWAP,
+
        /*--- Special stuff -------------------------------------------------*/
 
        /** Scan options supported by the driver. */
@@ -764,6 +788,8 @@ struct sr_dev_inst {
        char *model;
        char *version;
        GSList *probes;
+       /* List of sr_probe_group structs */
+       GSList *probe_groups;
        void *conn;
        void *priv;
 };
@@ -801,11 +827,14 @@ struct sr_dev_driver {
        GSList *(*dev_list) (void);
        int (*dev_clear) (void);
        int (*config_get) (int id, GVariant **data,
-                       const struct sr_dev_inst *sdi);
+                       const struct sr_dev_inst *sdi,
+                       const struct sr_probe_group *probe_group);
        int (*config_set) (int id, GVariant *data,
-                       const struct sr_dev_inst *sdi);
+                       const struct sr_dev_inst *sdi,
+                       const struct sr_probe_group *probe_group);
        int (*config_list) (int info_id, GVariant **data,
-                       const struct sr_dev_inst *sdi);
+                       const struct sr_dev_inst *sdi,
+                       const struct sr_probe_group *probe_group);
 
        /* Device-specific */
        int (*dev_open) (struct sr_dev_inst *sdi);
@@ -825,6 +854,7 @@ struct sr_session {
        /** List of struct datafeed_callback pointers. */
        GSList *datafeed_callbacks;
        GTimeVal starttime;
+       gboolean running;
 
        unsigned int num_sources;